Interface PcaConnectorAdAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PcaConnectorAdAsyncClient extends AwsClient
Service client for accessing PcaConnectorAd asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported 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.Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that enables you to provision security certificates for AD signed by a private CA that you own. For more information, see Amazon Web Services Private CA Connector for Active Directory.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createConnector
default CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest createConnectorRequest)
Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.
- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createConnector
default CompletableFuture<CreateConnectorResponse> createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)
Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDirectoryRegistration
default CompletableFuture<CreateDirectoryRegistrationResponse> createDirectoryRegistration(CreateDirectoryRegistrationRequest createDirectoryRegistrationRequest)
Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
- Parameters:
createDirectoryRegistrationRequest-- Returns:
- A Java Future containing the result of the CreateDirectoryRegistration 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDirectoryRegistration
default CompletableFuture<CreateDirectoryRegistrationResponse> createDirectoryRegistration(Consumer<CreateDirectoryRegistrationRequest.Builder> createDirectoryRegistrationRequest)
Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
This is a convenience which creates an instance of the
CreateDirectoryRegistrationRequest.Builderavoiding the need to create one manually viaCreateDirectoryRegistrationRequest.builder()- Parameters:
createDirectoryRegistrationRequest- AConsumerthat will call methods onCreateDirectoryRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDirectoryRegistration 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createServicePrincipalName
default CompletableFuture<CreateServicePrincipalNameResponse> createServicePrincipalName(CreateServicePrincipalNameRequest createServicePrincipalNameRequest)
Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.
- Parameters:
createServicePrincipalNameRequest-- Returns:
- A Java Future containing the result of the CreateServicePrincipalName 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createServicePrincipalName
default CompletableFuture<CreateServicePrincipalNameResponse> createServicePrincipalName(Consumer<CreateServicePrincipalNameRequest.Builder> createServicePrincipalNameRequest)
Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.
This is a convenience which creates an instance of the
CreateServicePrincipalNameRequest.Builderavoiding the need to create one manually viaCreateServicePrincipalNameRequest.builder()- Parameters:
createServicePrincipalNameRequest- AConsumerthat will call methods onCreateServicePrincipalNameRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateServicePrincipalName 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest)
Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.
- Parameters:
createTemplateRequest-- Returns:
- A Java Future containing the result of the CreateTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.
This is a convenience which creates an instance of the
CreateTemplateRequest.Builderavoiding the need to create one manually viaCreateTemplateRequest.builder()- Parameters:
createTemplateRequest- AConsumerthat will call methods onCreateTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplateGroupAccessControlEntry
default CompletableFuture<CreateTemplateGroupAccessControlEntryResponse> createTemplateGroupAccessControlEntry(CreateTemplateGroupAccessControlEntryRequest createTemplateGroupAccessControlEntryRequest)
Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).
- Parameters:
createTemplateGroupAccessControlEntryRequest-- Returns:
- A Java Future containing the result of the CreateTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplateGroupAccessControlEntry
default CompletableFuture<CreateTemplateGroupAccessControlEntryResponse> createTemplateGroupAccessControlEntry(Consumer<CreateTemplateGroupAccessControlEntryRequest.Builder> createTemplateGroupAccessControlEntryRequest)
Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).
This is a convenience which creates an instance of the
CreateTemplateGroupAccessControlEntryRequest.Builderavoiding the need to create one manually viaCreateTemplateGroupAccessControlEntryRequest.builder()- Parameters:
createTemplateGroupAccessControlEntryRequest- AConsumerthat will call methods onCreateTemplateGroupAccessControlEntryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConnector
default CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.
- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteConnector
default CompletableFuture<DeleteConnectorResponse> deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)
Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDirectoryRegistration
default CompletableFuture<DeleteDirectoryRegistrationResponse> deleteDirectoryRegistration(DeleteDirectoryRegistrationRequest deleteDirectoryRegistrationRequest)
Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.
- Parameters:
deleteDirectoryRegistrationRequest-- Returns:
- A Java Future containing the result of the DeleteDirectoryRegistration 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDirectoryRegistration
default CompletableFuture<DeleteDirectoryRegistrationResponse> deleteDirectoryRegistration(Consumer<DeleteDirectoryRegistrationRequest.Builder> deleteDirectoryRegistrationRequest)
Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.
This is a convenience which creates an instance of the
DeleteDirectoryRegistrationRequest.Builderavoiding the need to create one manually viaDeleteDirectoryRegistrationRequest.builder()- Parameters:
deleteDirectoryRegistrationRequest- AConsumerthat will call methods onDeleteDirectoryRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDirectoryRegistration 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteServicePrincipalName
default CompletableFuture<DeleteServicePrincipalNameResponse> deleteServicePrincipalName(DeleteServicePrincipalNameRequest deleteServicePrincipalNameRequest)
Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
- Parameters:
deleteServicePrincipalNameRequest-- Returns:
- A Java Future containing the result of the DeleteServicePrincipalName 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteServicePrincipalName
default CompletableFuture<DeleteServicePrincipalNameResponse> deleteServicePrincipalName(Consumer<DeleteServicePrincipalNameRequest.Builder> deleteServicePrincipalNameRequest)
Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
This is a convenience which creates an instance of the
DeleteServicePrincipalNameRequest.Builderavoiding the need to create one manually viaDeleteServicePrincipalNameRequest.builder()- Parameters:
deleteServicePrincipalNameRequest- AConsumerthat will call methods onDeleteServicePrincipalNameRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteServicePrincipalName 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.
- Parameters:
deleteTemplateRequest-- Returns:
- A Java Future containing the result of the DeleteTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.
This is a convenience which creates an instance of the
DeleteTemplateRequest.Builderavoiding the need to create one manually viaDeleteTemplateRequest.builder()- Parameters:
deleteTemplateRequest- AConsumerthat will call methods onDeleteTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplateGroupAccessControlEntry
default CompletableFuture<DeleteTemplateGroupAccessControlEntryResponse> deleteTemplateGroupAccessControlEntry(DeleteTemplateGroupAccessControlEntryRequest deleteTemplateGroupAccessControlEntryRequest)
Deletes a group access control entry.
- Parameters:
deleteTemplateGroupAccessControlEntryRequest-- Returns:
- A Java Future containing the result of the DeleteTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplateGroupAccessControlEntry
default CompletableFuture<DeleteTemplateGroupAccessControlEntryResponse> deleteTemplateGroupAccessControlEntry(Consumer<DeleteTemplateGroupAccessControlEntryRequest.Builder> deleteTemplateGroupAccessControlEntryRequest)
Deletes a group access control entry.
This is a convenience which creates an instance of the
DeleteTemplateGroupAccessControlEntryRequest.Builderavoiding the need to create one manually viaDeleteTemplateGroupAccessControlEntryRequest.builder()- Parameters:
deleteTemplateGroupAccessControlEntryRequest- AConsumerthat will call methods onDeleteTemplateGroupAccessControlEntryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConnector
default CompletableFuture<GetConnectorResponse> getConnector(GetConnectorRequest getConnectorRequest)
Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).
- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getConnector
default CompletableFuture<GetConnectorResponse> getConnector(Consumer<GetConnectorRequest.Builder> getConnectorRequest)
Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDirectoryRegistration
default CompletableFuture<GetDirectoryRegistrationResponse> getDirectoryRegistration(GetDirectoryRegistrationRequest getDirectoryRegistrationRequest)
A structure that contains information about your directory registration.
- Parameters:
getDirectoryRegistrationRequest-- Returns:
- A Java Future containing the result of the GetDirectoryRegistration 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDirectoryRegistration
default CompletableFuture<GetDirectoryRegistrationResponse> getDirectoryRegistration(Consumer<GetDirectoryRegistrationRequest.Builder> getDirectoryRegistrationRequest)
A structure that contains information about your directory registration.
This is a convenience which creates an instance of the
GetDirectoryRegistrationRequest.Builderavoiding the need to create one manually viaGetDirectoryRegistrationRequest.builder()- Parameters:
getDirectoryRegistrationRequest- AConsumerthat will call methods onGetDirectoryRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDirectoryRegistration 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getServicePrincipalName
default CompletableFuture<GetServicePrincipalNameResponse> getServicePrincipalName(GetServicePrincipalNameRequest getServicePrincipalNameRequest)
Lists the service principal name that the connector uses to authenticate with Active Directory.
- Parameters:
getServicePrincipalNameRequest-- Returns:
- A Java Future containing the result of the GetServicePrincipalName 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getServicePrincipalName
default CompletableFuture<GetServicePrincipalNameResponse> getServicePrincipalName(Consumer<GetServicePrincipalNameRequest.Builder> getServicePrincipalNameRequest)
Lists the service principal name that the connector uses to authenticate with Active Directory.
This is a convenience which creates an instance of the
GetServicePrincipalNameRequest.Builderavoiding the need to create one manually viaGetServicePrincipalNameRequest.builder()- Parameters:
getServicePrincipalNameRequest- AConsumerthat will call methods onGetServicePrincipalNameRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetServicePrincipalName 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getTemplate
default CompletableFuture<GetTemplateResponse> getTemplate(GetTemplateRequest getTemplateRequest)
Retrieves a certificate template that the connector uses to issue certificates from a private CA.
- Parameters:
getTemplateRequest-- Returns:
- A Java Future containing the result of the GetTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getTemplate
default CompletableFuture<GetTemplateResponse> getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)
Retrieves a certificate template that the connector uses to issue certificates from a private CA.
This is a convenience which creates an instance of the
GetTemplateRequest.Builderavoiding the need to create one manually viaGetTemplateRequest.builder()- Parameters:
getTemplateRequest- AConsumerthat will call methods onGetTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getTemplateGroupAccessControlEntry
default CompletableFuture<GetTemplateGroupAccessControlEntryResponse> getTemplateGroupAccessControlEntry(GetTemplateGroupAccessControlEntryRequest getTemplateGroupAccessControlEntryRequest)
Retrieves the group access control entries for a template.
- Parameters:
getTemplateGroupAccessControlEntryRequest-- Returns:
- A Java Future containing the result of the GetTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getTemplateGroupAccessControlEntry
default CompletableFuture<GetTemplateGroupAccessControlEntryResponse> getTemplateGroupAccessControlEntry(Consumer<GetTemplateGroupAccessControlEntryRequest.Builder> getTemplateGroupAccessControlEntryRequest)
Retrieves the group access control entries for a template.
This is a convenience which creates an instance of the
GetTemplateGroupAccessControlEntryRequest.Builderavoiding the need to create one manually viaGetTemplateGroupAccessControlEntryRequest.builder()- Parameters:
getTemplateGroupAccessControlEntryRequest- AConsumerthat will call methods onGetTemplateGroupAccessControlEntryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectors
default CompletableFuture<ListConnectorsResponse> listConnectors(ListConnectorsRequest listConnectorsRequest)
Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectors
default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectorsPaginator
default ListConnectorsPublisher listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)
This is a variant of
listConnectors(software.amazon.awssdk.services.pcaconnectorad.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.pcaconnectorad.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.pcaconnectorad.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.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.pcaconnectorad.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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listConnectorsPaginator
default ListConnectorsPublisher listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
This is a variant of
listConnectors(software.amazon.awssdk.services.pcaconnectorad.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.pcaconnectorad.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.pcaconnectorad.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.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.pcaconnectorad.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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDirectoryRegistrations
default CompletableFuture<ListDirectoryRegistrationsResponse> listDirectoryRegistrations(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest)
Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.
- Parameters:
listDirectoryRegistrationsRequest-- Returns:
- A Java Future containing the result of the ListDirectoryRegistrations 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDirectoryRegistrations
default CompletableFuture<ListDirectoryRegistrationsResponse> listDirectoryRegistrations(Consumer<ListDirectoryRegistrationsRequest.Builder> listDirectoryRegistrationsRequest)
Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.
This is a convenience which creates an instance of the
ListDirectoryRegistrationsRequest.Builderavoiding the need to create one manually viaListDirectoryRegistrationsRequest.builder()- Parameters:
listDirectoryRegistrationsRequest- AConsumerthat will call methods onListDirectoryRegistrationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDirectoryRegistrations 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDirectoryRegistrationsPaginator
default ListDirectoryRegistrationsPublisher listDirectoryRegistrationsPaginator(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest)
This is a variant of
listDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)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.pcaconnectorad.paginators.ListDirectoryRegistrationsPublisher publisher = client.listDirectoryRegistrationsPaginator(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.pcaconnectorad.paginators.ListDirectoryRegistrationsPublisher publisher = client.listDirectoryRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsResponse 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
listDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)operation.- Parameters:
listDirectoryRegistrationsRequest-- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDirectoryRegistrationsPaginator
default ListDirectoryRegistrationsPublisher listDirectoryRegistrationsPaginator(Consumer<ListDirectoryRegistrationsRequest.Builder> listDirectoryRegistrationsRequest)
This is a variant of
listDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)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.pcaconnectorad.paginators.ListDirectoryRegistrationsPublisher publisher = client.listDirectoryRegistrationsPaginator(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.pcaconnectorad.paginators.ListDirectoryRegistrationsPublisher publisher = client.listDirectoryRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsResponse 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
listDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)operation.
This is a convenience which creates an instance of the
ListDirectoryRegistrationsRequest.Builderavoiding the need to create one manually viaListDirectoryRegistrationsRequest.builder()- Parameters:
listDirectoryRegistrationsRequest- AConsumerthat will call methods onListDirectoryRegistrationsRequest.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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listServicePrincipalNames
default CompletableFuture<ListServicePrincipalNamesResponse> listServicePrincipalNames(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest)
Lists the service principal names that the connector uses to authenticate with Active Directory.
- Parameters:
listServicePrincipalNamesRequest-- Returns:
- A Java Future containing the result of the ListServicePrincipalNames 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listServicePrincipalNames
default CompletableFuture<ListServicePrincipalNamesResponse> listServicePrincipalNames(Consumer<ListServicePrincipalNamesRequest.Builder> listServicePrincipalNamesRequest)
Lists the service principal names that the connector uses to authenticate with Active Directory.
This is a convenience which creates an instance of the
ListServicePrincipalNamesRequest.Builderavoiding the need to create one manually viaListServicePrincipalNamesRequest.builder()- Parameters:
listServicePrincipalNamesRequest- AConsumerthat will call methods onListServicePrincipalNamesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListServicePrincipalNames 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listServicePrincipalNamesPaginator
default ListServicePrincipalNamesPublisher listServicePrincipalNamesPaginator(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest)
This is a variant of
listServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)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.pcaconnectorad.paginators.ListServicePrincipalNamesPublisher publisher = client.listServicePrincipalNamesPaginator(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.pcaconnectorad.paginators.ListServicePrincipalNamesPublisher publisher = client.listServicePrincipalNamesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesResponse 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
listServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)operation.- Parameters:
listServicePrincipalNamesRequest-- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listServicePrincipalNamesPaginator
default ListServicePrincipalNamesPublisher listServicePrincipalNamesPaginator(Consumer<ListServicePrincipalNamesRequest.Builder> listServicePrincipalNamesRequest)
This is a variant of
listServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)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.pcaconnectorad.paginators.ListServicePrincipalNamesPublisher publisher = client.listServicePrincipalNamesPaginator(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.pcaconnectorad.paginators.ListServicePrincipalNamesPublisher publisher = client.listServicePrincipalNamesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesResponse 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
listServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)operation.
This is a convenience which creates an instance of the
ListServicePrincipalNamesRequest.Builderavoiding the need to create one manually viaListServicePrincipalNamesRequest.builder()- Parameters:
listServicePrincipalNamesRequest- AConsumerthat will call methods onListServicePrincipalNamesRequest.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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags, if any, that are associated with your 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags, if any, that are associated with your 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntries
default CompletableFuture<ListTemplateGroupAccessControlEntriesResponse> listTemplateGroupAccessControlEntries(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest)
Lists group access control entries you created.
- Parameters:
listTemplateGroupAccessControlEntriesRequest-- Returns:
- A Java Future containing the result of the ListTemplateGroupAccessControlEntries 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntries
default CompletableFuture<ListTemplateGroupAccessControlEntriesResponse> listTemplateGroupAccessControlEntries(Consumer<ListTemplateGroupAccessControlEntriesRequest.Builder> listTemplateGroupAccessControlEntriesRequest)
Lists group access control entries you created.
This is a convenience which creates an instance of the
ListTemplateGroupAccessControlEntriesRequest.Builderavoiding the need to create one manually viaListTemplateGroupAccessControlEntriesRequest.builder()- Parameters:
listTemplateGroupAccessControlEntriesRequest- AConsumerthat will call methods onListTemplateGroupAccessControlEntriesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTemplateGroupAccessControlEntries 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntriesPaginator
default ListTemplateGroupAccessControlEntriesPublisher listTemplateGroupAccessControlEntriesPaginator(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest)
This is a variant of
listTemplateGroupAccessControlEntries(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesRequest)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.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesPublisher publisher = client.listTemplateGroupAccessControlEntriesPaginator(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.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesPublisher publisher = client.listTemplateGroupAccessControlEntriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesResponse 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
listTemplateGroupAccessControlEntries(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesRequest)operation.- Parameters:
listTemplateGroupAccessControlEntriesRequest-- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntriesPaginator
default ListTemplateGroupAccessControlEntriesPublisher listTemplateGroupAccessControlEntriesPaginator(Consumer<ListTemplateGroupAccessControlEntriesRequest.Builder> listTemplateGroupAccessControlEntriesRequest)
This is a variant of
listTemplateGroupAccessControlEntries(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesRequest)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.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesPublisher publisher = client.listTemplateGroupAccessControlEntriesPaginator(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.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesPublisher publisher = client.listTemplateGroupAccessControlEntriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesResponse 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
listTemplateGroupAccessControlEntries(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesRequest)operation.
This is a convenience which creates an instance of the
ListTemplateGroupAccessControlEntriesRequest.Builderavoiding the need to create one manually viaListTemplateGroupAccessControlEntriesRequest.builder()- Parameters:
listTemplateGroupAccessControlEntriesRequest- AConsumerthat will call methods onListTemplateGroupAccessControlEntriesRequest.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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists the templates, if any, that are associated with a connector.
- Parameters:
listTemplatesRequest-- Returns:
- A Java Future containing the result of the ListTemplates 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
Lists the templates, if any, that are associated with a connector.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTemplates 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesPublisher listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
This is a variant of
listTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)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.pcaconnectorad.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(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.pcaconnectorad.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesResponse 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
listTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)operation.- Parameters:
listTemplatesRequest-- 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesPublisher listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
This is a variant of
listTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)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.pcaconnectorad.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(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.pcaconnectorad.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesResponse 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
listTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Update template configuration to define the information included in certificates.
- Parameters:
updateTemplateRequest-- Returns:
- A Java Future containing the result of the UpdateTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
Update template configuration to define the information included in certificates.
This is a convenience which creates an instance of the
UpdateTemplateRequest.Builderavoiding the need to create one manually viaUpdateTemplateRequest.builder()- Parameters:
updateTemplateRequest- AConsumerthat will call methods onUpdateTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTemplate 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplateGroupAccessControlEntry
default CompletableFuture<UpdateTemplateGroupAccessControlEntryResponse> updateTemplateGroupAccessControlEntry(UpdateTemplateGroupAccessControlEntryRequest updateTemplateGroupAccessControlEntryRequest)
Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.
- Parameters:
updateTemplateGroupAccessControlEntryRequest-- Returns:
- A Java Future containing the result of the UpdateTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplateGroupAccessControlEntry
default CompletableFuture<UpdateTemplateGroupAccessControlEntryResponse> updateTemplateGroupAccessControlEntry(Consumer<UpdateTemplateGroupAccessControlEntryRequest.Builder> updateTemplateGroupAccessControlEntryRequest)
Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.
This is a convenience which creates an instance of the
UpdateTemplateGroupAccessControlEntryRequest.Builderavoiding the need to create one manually viaUpdateTemplateGroupAccessControlEntryRequest.builder()- Parameters:
updateTemplateGroupAccessControlEntryRequest- AConsumerthat will call methods onUpdateTemplateGroupAccessControlEntryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTemplateGroupAccessControlEntry 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.- AccessDeniedException You can receive this error if you attempt to create a resource share when 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.
- ValidationException An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
- ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
- ThrottlingException The limit on the number of requests per second was exceeded.
- InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
- ConflictException This request cannot 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.
- PcaConnectorAdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default PcaConnectorAdServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static PcaConnectorAdAsyncClient create()
Create aPcaConnectorAdAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PcaConnectorAdAsyncClientBuilder builder()
Create a builder that can be used to configure and create aPcaConnectorAdAsyncClient.
-
-