Interface PcaConnectorScepAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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.
Connector for SCEP creates a connector between Amazon Web Services Private CA and your SCEP-enabled clients and devices. For more information, see Connector for SCEP in the Amazon Web Services Private CA User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aPcaConnectorScepAsyncClient.static PcaConnectorScepAsyncClientcreate()Create aPcaConnectorScepAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateChallengeResponse> createChallenge(Consumer<CreateChallengeRequest.Builder> createChallengeRequest) For general-purpose connectors.default CompletableFuture<CreateChallengeResponse> createChallenge(CreateChallengeRequest createChallengeRequest) For general-purpose connectors.default CompletableFuture<CreateConnectorResponse> createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest) Creates a SCEP connector.default CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest createConnectorRequest) Creates a SCEP connector.default CompletableFuture<DeleteChallengeResponse> deleteChallenge(Consumer<DeleteChallengeRequest.Builder> deleteChallengeRequest) Deletes the specified Challenge.default CompletableFuture<DeleteChallengeResponse> deleteChallenge(DeleteChallengeRequest deleteChallengeRequest) Deletes the specified Challenge.default CompletableFuture<DeleteConnectorResponse> deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) Deletes the specified Connector.default CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest deleteConnectorRequest) Deletes the specified Connector.getChallengeMetadata(Consumer<GetChallengeMetadataRequest.Builder> getChallengeMetadataRequest) Retrieves the metadata for the specified Challenge.getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest) Retrieves the metadata for the specified Challenge.getChallengePassword(Consumer<GetChallengePasswordRequest.Builder> getChallengePasswordRequest) Retrieves the challenge password for the specified Challenge.getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest) Retrieves the challenge password for the specified Challenge.default CompletableFuture<GetConnectorResponse> getConnector(Consumer<GetConnectorRequest.Builder> getConnectorRequest) Retrieves details about the specified Connector.default CompletableFuture<GetConnectorResponse> getConnector(GetConnectorRequest getConnectorRequest) Retrieves details about the specified Connector.listChallengeMetadata(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest) Retrieves the challenge metadata for the specified ARN.listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest) Retrieves the challenge metadata for the specified ARN.default ListChallengeMetadataPublisherlistChallengeMetadataPaginator(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest) This is a variant oflistChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest)operation.default ListChallengeMetadataPublisherlistChallengeMetadataPaginator(ListChallengeMetadataRequest listChallengeMetadataRequest) This is a variant oflistChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest)operation.default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) Lists the connectors belonging to your Amazon Web Services account.default CompletableFuture<ListConnectorsResponse> listConnectors(ListConnectorsRequest listConnectorsRequest) Lists the connectors belonging to your Amazon Web Services account.default ListConnectorsPublisherlistConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest)operation.default ListConnectorsPublisherlistConnectorsPaginator(ListConnectorsRequest listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the tags associated with the specified resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the tags associated with the specified resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to your resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to your resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from your resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from your resource.Methods 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
-
createChallenge
default CompletableFuture<CreateChallengeResponse> createChallenge(CreateChallengeRequest createChallengeRequest) For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.
To create additional challenge passwords for the connector, call
CreateChallengeagain. We recommend frequently rotating your challenge passwords.- Parameters:
createChallengeRequest-- Returns:
- A Java Future containing the result of the CreateChallenge 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - BadRequestException The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
createChallenge
default CompletableFuture<CreateChallengeResponse> createChallenge(Consumer<CreateChallengeRequest.Builder> createChallengeRequest) For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.
To create additional challenge passwords for the connector, call
CreateChallengeagain. We recommend frequently rotating your challenge passwords.
This is a convenience which creates an instance of the
CreateChallengeRequest.Builderavoiding the need to create one manually viaCreateChallengeRequest.builder()- Parameters:
createChallengeRequest- AConsumerthat will call methods onCreateChallengeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateChallenge 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - BadRequestException The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
createConnector
default CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest createConnectorRequest) Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.
- Parameters:
createConnectorRequest-- Returns:
- A Java Future containing the result of the CreateConnector 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
createConnector
default CompletableFuture<CreateConnectorResponse> createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest) Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.
This is a convenience which creates an instance of the
CreateConnectorRequest.Builderavoiding the need to create one manually viaCreateConnectorRequest.builder()- Parameters:
createConnectorRequest- AConsumerthat will call methods onCreateConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateConnector 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
deleteChallenge
default CompletableFuture<DeleteChallengeResponse> deleteChallenge(DeleteChallengeRequest deleteChallengeRequest) Deletes the specified Challenge.
- Parameters:
deleteChallengeRequest-- Returns:
- A Java Future containing the result of the DeleteChallenge 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
deleteChallenge
default CompletableFuture<DeleteChallengeResponse> deleteChallenge(Consumer<DeleteChallengeRequest.Builder> deleteChallengeRequest) Deletes the specified Challenge.
This is a convenience which creates an instance of the
DeleteChallengeRequest.Builderavoiding the need to create one manually viaDeleteChallengeRequest.builder()- Parameters:
deleteChallengeRequest- AConsumerthat will call methods onDeleteChallengeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteChallenge 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
deleteConnector
default CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest deleteConnectorRequest) Deletes the specified Connector. This operation also deletes any challenges associated with the connector.
- Parameters:
deleteConnectorRequest-- Returns:
- A Java Future containing the result of the DeleteConnector 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
deleteConnector
default CompletableFuture<DeleteConnectorResponse> deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) Deletes the specified Connector. This operation also deletes any challenges associated with the connector.
This is a convenience which creates an instance of the
DeleteConnectorRequest.Builderavoiding the need to create one manually viaDeleteConnectorRequest.builder()- Parameters:
deleteConnectorRequest- AConsumerthat will call methods onDeleteConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteConnector 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- ConflictException This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
getChallengeMetadata
default CompletableFuture<GetChallengeMetadataResponse> getChallengeMetadata(GetChallengeMetadataRequest getChallengeMetadataRequest) Retrieves the metadata for the specified Challenge.
- Parameters:
getChallengeMetadataRequest-- Returns:
- A Java Future containing the result of the GetChallengeMetadata 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
getChallengeMetadata
default CompletableFuture<GetChallengeMetadataResponse> getChallengeMetadata(Consumer<GetChallengeMetadataRequest.Builder> getChallengeMetadataRequest) Retrieves the metadata for the specified Challenge.
This is a convenience which creates an instance of the
GetChallengeMetadataRequest.Builderavoiding the need to create one manually viaGetChallengeMetadataRequest.builder()- Parameters:
getChallengeMetadataRequest- AConsumerthat will call methods onGetChallengeMetadataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetChallengeMetadata 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
getChallengePassword
default CompletableFuture<GetChallengePasswordResponse> getChallengePassword(GetChallengePasswordRequest getChallengePasswordRequest) Retrieves the challenge password for the specified Challenge.
- Parameters:
getChallengePasswordRequest-- Returns:
- A Java Future containing the result of the GetChallengePassword 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
getChallengePassword
default CompletableFuture<GetChallengePasswordResponse> getChallengePassword(Consumer<GetChallengePasswordRequest.Builder> getChallengePasswordRequest) Retrieves the challenge password for the specified Challenge.
This is a convenience which creates an instance of the
GetChallengePasswordRequest.Builderavoiding the need to create one manually viaGetChallengePasswordRequest.builder()- Parameters:
getChallengePasswordRequest- AConsumerthat will call methods onGetChallengePasswordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetChallengePassword 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
getConnector
default CompletableFuture<GetConnectorResponse> getConnector(GetConnectorRequest getConnectorRequest) Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.
- Parameters:
getConnectorRequest-- Returns:
- A Java Future containing the result of the GetConnector 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
getConnector
default CompletableFuture<GetConnectorResponse> getConnector(Consumer<GetConnectorRequest.Builder> getConnectorRequest) Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.
This is a convenience which creates an instance of the
GetConnectorRequest.Builderavoiding the need to create one manually viaGetConnectorRequest.builder()- Parameters:
getConnectorRequest- AConsumerthat will call methods onGetConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetConnector 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
listChallengeMetadata
default CompletableFuture<ListChallengeMetadataResponse> listChallengeMetadata(ListChallengeMetadataRequest listChallengeMetadataRequest) Retrieves the challenge metadata for the specified ARN.
- Parameters:
listChallengeMetadataRequest-- Returns:
- A Java Future containing the result of the ListChallengeMetadata 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
listChallengeMetadata
default CompletableFuture<ListChallengeMetadataResponse> listChallengeMetadata(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest) Retrieves the challenge metadata for the specified ARN.
This is a convenience which creates an instance of the
ListChallengeMetadataRequest.Builderavoiding the need to create one manually viaListChallengeMetadataRequest.builder()- Parameters:
listChallengeMetadataRequest- AConsumerthat will call methods onListChallengeMetadataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListChallengeMetadata 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.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
listChallengeMetadataPaginator
default ListChallengeMetadataPublisher listChallengeMetadataPaginator(ListChallengeMetadataRequest listChallengeMetadataRequest) This is a variant of
listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest)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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataPublisher publisher = client.listChallengeMetadataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataPublisher publisher = client.listChallengeMetadataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataResponse response) { //... }; });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
listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest)operation.- Parameters:
listChallengeMetadataRequest-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
listChallengeMetadataPaginator
default ListChallengeMetadataPublisher listChallengeMetadataPaginator(Consumer<ListChallengeMetadataRequest.Builder> listChallengeMetadataRequest) This is a variant of
listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest)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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataPublisher publisher = client.listChallengeMetadataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcaconnectorscep.paginators.ListChallengeMetadataPublisher publisher = client.listChallengeMetadataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataResponse response) { //... }; });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
listChallengeMetadata(software.amazon.awssdk.services.pcaconnectorscep.model.ListChallengeMetadataRequest)operation.
This is a convenience which creates an instance of the
ListChallengeMetadataRequest.Builderavoiding the need to create one manually viaListChallengeMetadataRequest.builder()- Parameters:
listChallengeMetadataRequest- AConsumerthat will call methods onListChallengeMetadataRequest.Builderto create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
listConnectors
default CompletableFuture<ListConnectorsResponse> listConnectors(ListConnectorsRequest listConnectorsRequest) Lists the connectors belonging to your Amazon Web Services account.
- Parameters:
listConnectorsRequest-- Returns:
- A Java Future containing the result of the ListConnectors 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.- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectors
default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) Lists the connectors belonging to your Amazon Web Services account.
This is a convenience which creates an instance of the
ListConnectorsRequest.Builderavoiding the need to create one manually viaListConnectorsRequest.builder()- Parameters:
listConnectorsRequest- AConsumerthat will call methods onListConnectorsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListConnectors 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.- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectorsPaginator
default ListConnectorsPublisher listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest) This is a variant of
listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest)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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsResponse response) { //... }; });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
listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest)operation.- Parameters:
listConnectorsRequest-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectorsPaginator
default ListConnectorsPublisher listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) This is a variant of
listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest)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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcaconnectorscep.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsResponse response) { //... }; });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
listConnectors(software.amazon.awssdk.services.pcaconnectorscep.model.ListConnectorsRequest)operation.
This is a convenience which creates an instance of the
ListConnectorsRequest.Builderavoiding the need to create one manually viaListConnectorsRequest.builder()- Parameters:
listConnectorsRequest- AConsumerthat will call methods onListConnectorsRequest.Builderto create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
tagResource
Adds one or more tags to your resource.
- Parameters:
tagResourceRequest-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to your resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from your resource.
- Parameters:
untagResourceRequest-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from your resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
ACTIVE. - InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ValidationException An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
- ThrottlingException The limit on the number of requests per second was exceeded.
- AccessDeniedException You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
- 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.
- PcaConnectorScepException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might be
incorrectly specified, or it might have a status other than
- 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 aPcaConnectorScepAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aPcaConnectorScepAsyncClient.
-