Interface PcaConnectorAdClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PcaConnectorAdClient extends AwsClient
Service client for accessing PcaConnectorAd. This can be created using the staticbuilder()method.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 CreateConnectorResponse createConnector(CreateConnectorRequest createConnectorRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createConnector
default CreateConnectorResponse createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDirectoryRegistration
default CreateDirectoryRegistrationResponse createDirectoryRegistration(CreateDirectoryRegistrationRequest createDirectoryRegistrationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
- Parameters:
createDirectoryRegistrationRequest-- Returns:
- Result of the CreateDirectoryRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDirectoryRegistration
default CreateDirectoryRegistrationResponse createDirectoryRegistration(Consumer<CreateDirectoryRegistrationRequest.Builder> createDirectoryRegistrationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateDirectoryRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createServicePrincipalName
default CreateServicePrincipalNameResponse createServicePrincipalName(CreateServicePrincipalNameRequest createServicePrincipalNameRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateServicePrincipalName operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createServicePrincipalName
default CreateServicePrincipalNameResponse createServicePrincipalName(Consumer<CreateServicePrincipalNameRequest.Builder> createServicePrincipalNameRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateServicePrincipalName operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplate
default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplate
default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplateGroupAccessControlEntry
default CreateTemplateGroupAccessControlEntryResponse createTemplateGroupAccessControlEntry(CreateTemplateGroupAccessControlEntryRequest createTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplateGroupAccessControlEntry
default CreateTemplateGroupAccessControlEntryResponse createTemplateGroupAccessControlEntry(Consumer<CreateTemplateGroupAccessControlEntryRequest.Builder> createTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the CreateTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConnector
default DeleteConnectorResponse deleteConnector(DeleteConnectorRequest deleteConnectorRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the DeleteConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConnector
default DeleteConnectorResponse deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the DeleteConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDirectoryRegistration
default DeleteDirectoryRegistrationResponse deleteDirectoryRegistration(DeleteDirectoryRegistrationRequest deleteDirectoryRegistrationRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.
- Parameters:
deleteDirectoryRegistrationRequest-- Returns:
- Result of the DeleteDirectoryRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDirectoryRegistration
default DeleteDirectoryRegistrationResponse deleteDirectoryRegistration(Consumer<DeleteDirectoryRegistrationRequest.Builder> deleteDirectoryRegistrationRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the DeleteDirectoryRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServicePrincipalName
default DeleteServicePrincipalNameResponse deleteServicePrincipalName(DeleteServicePrincipalNameRequest deleteServicePrincipalNameRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
- Parameters:
deleteServicePrincipalNameRequest-- Returns:
- Result of the DeleteServicePrincipalName operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServicePrincipalName
default DeleteServicePrincipalNameResponse deleteServicePrincipalName(Consumer<DeleteServicePrincipalNameRequest.Builder> deleteServicePrincipalNameRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the DeleteServicePrincipalName operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplate
default DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.
- Parameters:
deleteTemplateRequest-- Returns:
- Result of the DeleteTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplate
default DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the DeleteTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplateGroupAccessControlEntry
default DeleteTemplateGroupAccessControlEntryResponse deleteTemplateGroupAccessControlEntry(DeleteTemplateGroupAccessControlEntryRequest deleteTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Deletes a group access control entry.
- Parameters:
deleteTemplateGroupAccessControlEntryRequest-- Returns:
- Result of the DeleteTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplateGroupAccessControlEntry
default DeleteTemplateGroupAccessControlEntryResponse deleteTemplateGroupAccessControlEntry(Consumer<DeleteTemplateGroupAccessControlEntryRequest.Builder> deleteTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the DeleteTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConnector
default GetConnectorResponse getConnector(GetConnectorRequest getConnectorRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).
- Parameters:
getConnectorRequest-- Returns:
- Result of the GetConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConnector
default GetConnectorResponse getConnector(Consumer<GetConnectorRequest.Builder> getConnectorRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the GetConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDirectoryRegistration
default GetDirectoryRegistrationResponse getDirectoryRegistration(GetDirectoryRegistrationRequest getDirectoryRegistrationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
A structure that contains information about your directory registration.
- Parameters:
getDirectoryRegistrationRequest-- Returns:
- Result of the GetDirectoryRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDirectoryRegistration
default GetDirectoryRegistrationResponse getDirectoryRegistration(Consumer<GetDirectoryRegistrationRequest.Builder> getDirectoryRegistrationRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the GetDirectoryRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServicePrincipalName
default GetServicePrincipalNameResponse getServicePrincipalName(GetServicePrincipalNameRequest getServicePrincipalNameRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Lists the service principal name that the connector uses to authenticate with Active Directory.
- Parameters:
getServicePrincipalNameRequest-- Returns:
- Result of the GetServicePrincipalName operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServicePrincipalName
default GetServicePrincipalNameResponse getServicePrincipalName(Consumer<GetServicePrincipalNameRequest.Builder> getServicePrincipalNameRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the GetServicePrincipalName operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTemplate
default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Retrieves a certificate template that the connector uses to issue certificates from a private CA.
- Parameters:
getTemplateRequest-- Returns:
- Result of the GetTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTemplate
default GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the GetTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTemplateGroupAccessControlEntry
default GetTemplateGroupAccessControlEntryResponse getTemplateGroupAccessControlEntry(GetTemplateGroupAccessControlEntryRequest getTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Retrieves the group access control entries for a template.
- Parameters:
getTemplateGroupAccessControlEntryRequest-- Returns:
- Result of the GetTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTemplateGroupAccessControlEntry
default GetTemplateGroupAccessControlEntryResponse getTemplateGroupAccessControlEntry(Consumer<GetTemplateGroupAccessControlEntryRequest.Builder> getTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the GetTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConnectors
default ListConnectorsResponse listConnectors(ListConnectorsRequest listConnectorsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListConnectors operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConnectors
default ListConnectorsResponse listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListConnectors operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConnectorsPaginator
default ListConnectorsIterable listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listConnectors(software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListConnectorsIterable responses = client .listConnectorsPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConnectorsPaginator
default ListConnectorsIterable listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listConnectors(software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListConnectorsIterable responses = client .listConnectorsPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDirectoryRegistrations
default ListDirectoryRegistrationsResponse listDirectoryRegistrations(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListDirectoryRegistrations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDirectoryRegistrations
default ListDirectoryRegistrationsResponse listDirectoryRegistrations(Consumer<ListDirectoryRegistrationsRequest.Builder> listDirectoryRegistrationsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListDirectoryRegistrations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDirectoryRegistrationsPaginator
default ListDirectoryRegistrationsIterable listDirectoryRegistrationsPaginator(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListDirectoryRegistrationsIterable responses = client.listDirectoryRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListDirectoryRegistrationsIterable responses = client .listDirectoryRegistrationsPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListDirectoryRegistrationsIterable responses = client.listDirectoryRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDirectoryRegistrationsPaginator
default ListDirectoryRegistrationsIterable listDirectoryRegistrationsPaginator(Consumer<ListDirectoryRegistrationsRequest.Builder> listDirectoryRegistrationsRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListDirectoryRegistrationsIterable responses = client.listDirectoryRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListDirectoryRegistrationsIterable responses = client .listDirectoryRegistrationsPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListDirectoryRegistrationsIterable responses = client.listDirectoryRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServicePrincipalNames
default ListServicePrincipalNamesResponse listServicePrincipalNames(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Lists the service principal names that the connector uses to authenticate with Active Directory.
- Parameters:
listServicePrincipalNamesRequest-- Returns:
- Result of the ListServicePrincipalNames operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServicePrincipalNames
default ListServicePrincipalNamesResponse listServicePrincipalNames(Consumer<ListServicePrincipalNamesRequest.Builder> listServicePrincipalNamesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListServicePrincipalNames operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServicePrincipalNamesPaginator
default ListServicePrincipalNamesIterable listServicePrincipalNamesPaginator(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListServicePrincipalNamesIterable responses = client.listServicePrincipalNamesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListServicePrincipalNamesIterable responses = client .listServicePrincipalNamesPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListServicePrincipalNamesIterable responses = client.listServicePrincipalNamesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServicePrincipalNamesPaginator
default ListServicePrincipalNamesIterable listServicePrincipalNamesPaginator(Consumer<ListServicePrincipalNamesRequest.Builder> listServicePrincipalNamesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListServicePrincipalNamesIterable responses = client.listServicePrincipalNamesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListServicePrincipalNamesIterable responses = client .listServicePrincipalNamesPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListServicePrincipalNamesIterable responses = client.listServicePrincipalNamesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Lists the tags, if any, that are associated with your resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntries
default ListTemplateGroupAccessControlEntriesResponse listTemplateGroupAccessControlEntries(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Lists group access control entries you created.
- Parameters:
listTemplateGroupAccessControlEntriesRequest-- Returns:
- Result of the ListTemplateGroupAccessControlEntries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntries
default ListTemplateGroupAccessControlEntriesResponse listTemplateGroupAccessControlEntries(Consumer<ListTemplateGroupAccessControlEntriesRequest.Builder> listTemplateGroupAccessControlEntriesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListTemplateGroupAccessControlEntries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntriesPaginator
default ListTemplateGroupAccessControlEntriesIterable listTemplateGroupAccessControlEntriesPaginator(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listTemplateGroupAccessControlEntries(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesIterable responses = client.listTemplateGroupAccessControlEntriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesIterable responses = client .listTemplateGroupAccessControlEntriesPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesIterable responses = client.listTemplateGroupAccessControlEntriesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateGroupAccessControlEntriesPaginator
default ListTemplateGroupAccessControlEntriesIterable listTemplateGroupAccessControlEntriesPaginator(Consumer<ListTemplateGroupAccessControlEntriesRequest.Builder> listTemplateGroupAccessControlEntriesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listTemplateGroupAccessControlEntries(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesIterable responses = client.listTemplateGroupAccessControlEntriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesIterable responses = client .listTemplateGroupAccessControlEntriesPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListTemplateGroupAccessControlEntriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplateGroupAccessControlEntriesIterable responses = client.listTemplateGroupAccessControlEntriesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplates
default ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Lists the templates, if any, that are associated with a connector.
- Parameters:
listTemplatesRequest-- Returns:
- Result of the ListTemplates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplates
default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the ListTemplates operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplatesIterable responses = client .listTemplatesPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
This is a variant of
listTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplatesIterable responses = client .listTemplatesPaginator(request); for (software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.pcaconnectorad.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Adds one or more tags to your resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
Removes one or more tags from your resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplate
default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Update template configuration to define the information included in certificates.
- Parameters:
updateTemplateRequest-- Returns:
- Result of the UpdateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplate
default UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the UpdateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplateGroupAccessControlEntry
default UpdateTemplateGroupAccessControlEntryResponse updateTemplateGroupAccessControlEntry(UpdateTemplateGroupAccessControlEntryRequest updateTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.
- Parameters:
updateTemplateGroupAccessControlEntryRequest-- Returns:
- Result of the UpdateTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplateGroupAccessControlEntry
default UpdateTemplateGroupAccessControlEntryResponse updateTemplateGroupAccessControlEntry(Consumer<UpdateTemplateGroupAccessControlEntryRequest.Builder> updateTemplateGroupAccessControlEntryRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, PcaConnectorAdException
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:
- Result of the UpdateTemplateGroupAccessControlEntry operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static PcaConnectorAdClient create()
Create aPcaConnectorAdClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PcaConnectorAdClientBuilder builder()
Create a builder that can be used to configure and create aPcaConnectorAdClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default PcaConnectorAdServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-