Interface PcaConnectorAdClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
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
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic PcaConnectorAdClientBuilder
builder()
Create a builder that can be used to configure and create aPcaConnectorAdClient
.static PcaConnectorAdClient
create()
Create aPcaConnectorAdClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateConnectorResponse
createConnector
(Consumer<CreateConnectorRequest.Builder> createConnectorRequest) Creates a connector between Amazon Web Services Private CA and an Active Directory.default CreateConnectorResponse
createConnector
(CreateConnectorRequest createConnectorRequest) Creates a connector between Amazon Web Services Private CA and an Active Directory.createDirectoryRegistration
(Consumer<CreateDirectoryRegistrationRequest.Builder> createDirectoryRegistrationRequest) Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active DirectorycreateDirectoryRegistration
(CreateDirectoryRegistrationRequest createDirectoryRegistrationRequest) Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active DirectorycreateServicePrincipalName
(Consumer<CreateServicePrincipalNameRequest.Builder> createServicePrincipalNameRequest) Creates a service principal name (SPN) for the service account in Active Directory.createServicePrincipalName
(CreateServicePrincipalNameRequest createServicePrincipalNameRequest) Creates a service principal name (SPN) for the service account in Active Directory.default CreateTemplateResponse
createTemplate
(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) Creates an Active Directory compatible certificate template.default CreateTemplateResponse
createTemplate
(CreateTemplateRequest createTemplateRequest) Creates an Active Directory compatible certificate template.createTemplateGroupAccessControlEntry
(Consumer<CreateTemplateGroupAccessControlEntryRequest.Builder> createTemplateGroupAccessControlEntryRequest) Create a group access control entry.createTemplateGroupAccessControlEntry
(CreateTemplateGroupAccessControlEntryRequest createTemplateGroupAccessControlEntryRequest) Create a group access control entry.default DeleteConnectorResponse
deleteConnector
(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest) Deletes a connector for Active Directory.default DeleteConnectorResponse
deleteConnector
(DeleteConnectorRequest deleteConnectorRequest) Deletes a connector for Active Directory.deleteDirectoryRegistration
(Consumer<DeleteDirectoryRegistrationRequest.Builder> deleteDirectoryRegistrationRequest) Deletes a directory registration.deleteDirectoryRegistration
(DeleteDirectoryRegistrationRequest deleteDirectoryRegistrationRequest) Deletes a directory registration.deleteServicePrincipalName
(Consumer<DeleteServicePrincipalNameRequest.Builder> deleteServicePrincipalNameRequest) Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.deleteServicePrincipalName
(DeleteServicePrincipalNameRequest deleteServicePrincipalNameRequest) Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.default DeleteTemplateResponse
deleteTemplate
(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) Deletes a template.default DeleteTemplateResponse
deleteTemplate
(DeleteTemplateRequest deleteTemplateRequest) Deletes a template.deleteTemplateGroupAccessControlEntry
(Consumer<DeleteTemplateGroupAccessControlEntryRequest.Builder> deleteTemplateGroupAccessControlEntryRequest) Deletes a group access control entry.deleteTemplateGroupAccessControlEntry
(DeleteTemplateGroupAccessControlEntryRequest deleteTemplateGroupAccessControlEntryRequest) Deletes a group access control entry.default GetConnectorResponse
getConnector
(Consumer<GetConnectorRequest.Builder> getConnectorRequest) Lists information about your connector.default GetConnectorResponse
getConnector
(GetConnectorRequest getConnectorRequest) Lists information about your connector.default GetDirectoryRegistrationResponse
getDirectoryRegistration
(Consumer<GetDirectoryRegistrationRequest.Builder> getDirectoryRegistrationRequest) A structure that contains information about your directory registration.default GetDirectoryRegistrationResponse
getDirectoryRegistration
(GetDirectoryRegistrationRequest getDirectoryRegistrationRequest) A structure that contains information about your directory registration.default GetServicePrincipalNameResponse
getServicePrincipalName
(Consumer<GetServicePrincipalNameRequest.Builder> getServicePrincipalNameRequest) Lists the service principal name that the connector uses to authenticate with Active Directory.default GetServicePrincipalNameResponse
getServicePrincipalName
(GetServicePrincipalNameRequest getServicePrincipalNameRequest) Lists the service principal name that the connector uses to authenticate with Active Directory.default GetTemplateResponse
getTemplate
(Consumer<GetTemplateRequest.Builder> getTemplateRequest) Retrieves a certificate template that the connector uses to issue certificates from a private CA.default GetTemplateResponse
getTemplate
(GetTemplateRequest getTemplateRequest) Retrieves a certificate template that the connector uses to issue certificates from a private CA.getTemplateGroupAccessControlEntry
(Consumer<GetTemplateGroupAccessControlEntryRequest.Builder> getTemplateGroupAccessControlEntryRequest) Retrieves the group access control entries for a template.getTemplateGroupAccessControlEntry
(GetTemplateGroupAccessControlEntryRequest getTemplateGroupAccessControlEntryRequest) Retrieves the group access control entries for a template.default ListConnectorsResponse
listConnectors
(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.default ListConnectorsResponse
listConnectors
(ListConnectorsRequest listConnectorsRequest) Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.default ListConnectorsIterable
listConnectorsPaginator
(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsRequest)
operation.default ListConnectorsIterable
listConnectorsPaginator
(ListConnectorsRequest listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.pcaconnectorad.model.ListConnectorsRequest)
operation.listDirectoryRegistrations
(Consumer<ListDirectoryRegistrationsRequest.Builder> listDirectoryRegistrationsRequest) Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.listDirectoryRegistrations
(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest) Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.listDirectoryRegistrationsPaginator
(Consumer<ListDirectoryRegistrationsRequest.Builder> listDirectoryRegistrationsRequest) This is a variant oflistDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)
operation.listDirectoryRegistrationsPaginator
(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest) This is a variant oflistDirectoryRegistrations(software.amazon.awssdk.services.pcaconnectorad.model.ListDirectoryRegistrationsRequest)
operation.listServicePrincipalNames
(Consumer<ListServicePrincipalNamesRequest.Builder> listServicePrincipalNamesRequest) Lists the service principal names that the connector uses to authenticate with Active Directory.listServicePrincipalNames
(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest) Lists the service principal names that the connector uses to authenticate with Active Directory.listServicePrincipalNamesPaginator
(Consumer<ListServicePrincipalNamesRequest.Builder> listServicePrincipalNamesRequest) This is a variant oflistServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)
operation.listServicePrincipalNamesPaginator
(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest) This is a variant oflistServicePrincipalNames(software.amazon.awssdk.services.pcaconnectorad.model.ListServicePrincipalNamesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags, if any, that are associated with your resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags, if any, that are associated with your resource.listTemplateGroupAccessControlEntries
(Consumer<ListTemplateGroupAccessControlEntriesRequest.Builder> listTemplateGroupAccessControlEntriesRequest) Lists group access control entries you created.listTemplateGroupAccessControlEntries
(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest) Lists group access control entries you created.listTemplateGroupAccessControlEntriesPaginator
(Consumer<ListTemplateGroupAccessControlEntriesRequest.Builder> listTemplateGroupAccessControlEntriesRequest) listTemplateGroupAccessControlEntriesPaginator
(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest) default ListTemplatesResponse
listTemplates
(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) Lists the templates, if any, that are associated with a connector.default ListTemplatesResponse
listTemplates
(ListTemplatesRequest listTemplatesRequest) Lists the templates, if any, that are associated with a connector.default ListTemplatesIterable
listTemplatesPaginator
(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) This is a variant oflistTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)
operation.default ListTemplatesIterable
listTemplatesPaginator
(ListTemplatesRequest listTemplatesRequest) This is a variant oflistTemplates(software.amazon.awssdk.services.pcaconnectorad.model.ListTemplatesRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to your resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to your resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from your resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from your resource.default UpdateTemplateResponse
updateTemplate
(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) Update template configuration to define the information included in certificates.default UpdateTemplateResponse
updateTemplate
(UpdateTemplateRequest updateTemplateRequest) Update template configuration to define the information included in certificates.updateTemplateGroupAccessControlEntry
(Consumer<UpdateTemplateGroupAccessControlEntryRequest.Builder> updateTemplateGroupAccessControlEntryRequest) Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.updateTemplateGroupAccessControlEntry
(UpdateTemplateGroupAccessControlEntryRequest updateTemplateGroupAccessControlEntryRequest) Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateConnectorRequest.builder()
- Parameters:
createConnectorRequest
- AConsumer
that will call methods onCreateConnectorRequest.Builder
to create a request.- Returns:
- Result of the CreateConnector operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateDirectoryRegistrationRequest.builder()
- Parameters:
createDirectoryRegistrationRequest
- AConsumer
that will call methods onCreateDirectoryRegistrationRequest.Builder
to create a request.- Returns:
- Result of the CreateDirectoryRegistration operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateServicePrincipalNameRequest.builder()
- Parameters:
createServicePrincipalNameRequest
- AConsumer
that will call methods onCreateServicePrincipalNameRequest.Builder
to create a request.- Returns:
- Result of the CreateServicePrincipalName operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateTemplateRequest.builder()
- Parameters:
createTemplateRequest
- AConsumer
that will call methods onCreateTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateTemplate operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateTemplateGroupAccessControlEntryRequest.builder()
- Parameters:
createTemplateGroupAccessControlEntryRequest
- AConsumer
that will call methods onCreateTemplateGroupAccessControlEntryRequest.Builder
to create a request.- Returns:
- Result of the CreateTemplateGroupAccessControlEntry operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteConnectorRequest.builder()
- Parameters:
deleteConnectorRequest
- AConsumer
that will call methods onDeleteConnectorRequest.Builder
to create a request.- Returns:
- Result of the DeleteConnector operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteDirectoryRegistrationRequest.builder()
- Parameters:
deleteDirectoryRegistrationRequest
- AConsumer
that will call methods onDeleteDirectoryRegistrationRequest.Builder
to create a request.- Returns:
- Result of the DeleteDirectoryRegistration operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteServicePrincipalNameRequest.builder()
- Parameters:
deleteServicePrincipalNameRequest
- AConsumer
that will call methods onDeleteServicePrincipalNameRequest.Builder
to create a request.- Returns:
- Result of the DeleteServicePrincipalName operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteTemplateRequest.builder()
- Parameters:
deleteTemplateRequest
- AConsumer
that will call methods onDeleteTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteTemplate operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteTemplateGroupAccessControlEntryRequest.builder()
- Parameters:
deleteTemplateGroupAccessControlEntryRequest
- AConsumer
that will call methods onDeleteTemplateGroupAccessControlEntryRequest.Builder
to create a request.- Returns:
- Result of the DeleteTemplateGroupAccessControlEntry operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetConnectorRequest.builder()
- Parameters:
getConnectorRequest
- AConsumer
that will call methods onGetConnectorRequest.Builder
to create a request.- Returns:
- Result of the GetConnector operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetDirectoryRegistrationRequest.builder()
- Parameters:
getDirectoryRegistrationRequest
- AConsumer
that will call methods onGetDirectoryRegistrationRequest.Builder
to create a request.- Returns:
- Result of the GetDirectoryRegistration operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetServicePrincipalNameRequest.builder()
- Parameters:
getServicePrincipalNameRequest
- AConsumer
that will call methods onGetServicePrincipalNameRequest.Builder
to create a request.- Returns:
- Result of the GetServicePrincipalName operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetTemplateRequest.builder()
- Parameters:
getTemplateRequest
- AConsumer
that will call methods onGetTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetTemplate operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetTemplateGroupAccessControlEntryRequest.builder()
- Parameters:
getTemplateGroupAccessControlEntryRequest
- AConsumer
that will call methods onGetTemplateGroupAccessControlEntryRequest.Builder
to create a request.- Returns:
- Result of the GetTemplateGroupAccessControlEntry operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListConnectorsRequest.builder()
- Parameters:
listConnectorsRequest
- AConsumer
that will call methods onListConnectorsRequest.Builder
to create a request.- Returns:
- Result of the ListConnectors operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListConnectorsRequest.builder()
- Parameters:
listConnectorsRequest
- AConsumer
that will call methods onListConnectorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListDirectoryRegistrationsRequest.builder()
- Parameters:
listDirectoryRegistrationsRequest
- AConsumer
that will call methods onListDirectoryRegistrationsRequest.Builder
to create a request.- Returns:
- Result of the ListDirectoryRegistrations operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDirectoryRegistrationsRequest.builder()
- Parameters:
listDirectoryRegistrationsRequest
- AConsumer
that will call methods onListDirectoryRegistrationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListServicePrincipalNamesRequest.builder()
- Parameters:
listServicePrincipalNamesRequest
- AConsumer
that will call methods onListServicePrincipalNamesRequest.Builder
to create a request.- Returns:
- Result of the ListServicePrincipalNames operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListServicePrincipalNamesRequest.builder()
- Parameters:
listServicePrincipalNamesRequest
- AConsumer
that will call methods onListServicePrincipalNamesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTemplateGroupAccessControlEntriesRequest.builder()
- Parameters:
listTemplateGroupAccessControlEntriesRequest
- AConsumer
that will call methods onListTemplateGroupAccessControlEntriesRequest.Builder
to create a request.- Returns:
- Result of the ListTemplateGroupAccessControlEntries operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListTemplateGroupAccessControlEntriesRequest.builder()
- Parameters:
listTemplateGroupAccessControlEntriesRequest
- AConsumer
that will call methods onListTemplateGroupAccessControlEntriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTemplatesRequest.builder()
- Parameters:
listTemplatesRequest
- AConsumer
that will call methods onListTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListTemplates operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListTemplatesRequest.builder()
- Parameters:
listTemplatesRequest
- AConsumer
that will call methods onListTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateTemplateRequest.builder()
- Parameters:
updateTemplateRequest
- AConsumer
that will call methods onUpdateTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateTemplate operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateTemplateGroupAccessControlEntryRequest.builder()
- Parameters:
updateTemplateGroupAccessControlEntryRequest
- AConsumer
that will call methods onUpdateTemplateGroupAccessControlEntryRequest.Builder
to create a request.- Returns:
- Result of the UpdateTemplateGroupAccessControlEntry operation returned by the service.
- See Also:
-
create
Create aPcaConnectorAdClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPcaConnectorAdClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-