com.amazonaws.services.pcaconnectorad

Class AWSPcaConnectorAdClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pcaconnectorad.AWSPcaConnectorAdClient

All Implemented Interfaces:

AWSPcaConnectorAd

Direct Known Subclasses:

AWSPcaConnectorAdAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSPcaConnectorAdClient
extends AmazonWebServiceClient
implements AWSPcaConnectorAd

Client for accessing PcaConnectorAd. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.pcaconnectorad.AWSPcaConnectorAd

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSPcaConnectorAdClientBuilder	builder()
CreateConnectorResult	createConnector(CreateConnectorRequest request) Creates a connector between Amazon Web Services Private CA and an Active Directory.
CreateDirectoryRegistrationResult	createDirectoryRegistration(CreateDirectoryRegistrationRequest request) Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
CreateServicePrincipalNameResult	createServicePrincipalName(CreateServicePrincipalNameRequest request) Creates a service principal name (SPN) for the service account in Active Directory.
CreateTemplateResult	createTemplate(CreateTemplateRequest request) Creates an Active Directory compatible certificate template.
CreateTemplateGroupAccessControlEntryResult	createTemplateGroupAccessControlEntry(CreateTemplateGroupAccessControlEntryRequest request) Create a group access control entry.
DeleteConnectorResult	deleteConnector(DeleteConnectorRequest request) Deletes a connector for Active Directory.
DeleteDirectoryRegistrationResult	deleteDirectoryRegistration(DeleteDirectoryRegistrationRequest request) Deletes a directory registration.
DeleteServicePrincipalNameResult	deleteServicePrincipalName(DeleteServicePrincipalNameRequest request) Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
DeleteTemplateResult	deleteTemplate(DeleteTemplateRequest request) Deletes a template.
DeleteTemplateGroupAccessControlEntryResult	deleteTemplateGroupAccessControlEntry(DeleteTemplateGroupAccessControlEntryRequest request) Deletes a group access control entry.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetConnectorResult	getConnector(GetConnectorRequest request) Lists information about your connector.
GetDirectoryRegistrationResult	getDirectoryRegistration(GetDirectoryRegistrationRequest request) A structure that contains information about your directory registration.
GetServicePrincipalNameResult	getServicePrincipalName(GetServicePrincipalNameRequest request) Lists the service principal name that the connector uses to authenticate with Active Directory.
GetTemplateResult	getTemplate(GetTemplateRequest request) Retrieves a certificate template that the connector uses to issue certificates from a private CA.
GetTemplateGroupAccessControlEntryResult	getTemplateGroupAccessControlEntry(GetTemplateGroupAccessControlEntryRequest request) Retrieves the group access control entries for a template.
ListConnectorsResult	listConnectors(ListConnectorsRequest request) Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
ListDirectoryRegistrationsResult	listDirectoryRegistrations(ListDirectoryRegistrationsRequest request) Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.
ListServicePrincipalNamesResult	listServicePrincipalNames(ListServicePrincipalNamesRequest request) Lists the service principal names that the connector uses to authenticate with Active Directory.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags, if any, that are associated with your resource.
ListTemplateGroupAccessControlEntriesResult	listTemplateGroupAccessControlEntries(ListTemplateGroupAccessControlEntriesRequest request) Lists group access control entries you created.
ListTemplatesResult	listTemplates(ListTemplatesRequest request) Lists the templates, if any, that are associated with a connector.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds one or more tags to your resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from your resource.
UpdateTemplateResult	updateTemplate(UpdateTemplateRequest request) Update template configuration to define the information included in certificates.
UpdateTemplateGroupAccessControlEntryResult	updateTemplateGroupAccessControlEntry(UpdateTemplateGroupAccessControlEntryRequest request) Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSPcaConnectorAdClientBuilder builder()

createConnector

public CreateConnectorResult createConnector(CreateConnectorRequest request)

Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.

Specified by:

createConnector in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

createDirectoryRegistration

public CreateDirectoryRegistrationResult createDirectoryRegistration(CreateDirectoryRegistrationRequest request)

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory

Specified by:

createDirectoryRegistration in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

createServicePrincipalName

public CreateServicePrincipalNameResult createServicePrincipalName(CreateServicePrincipalNameRequest request)

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.

Specified by:

createServicePrincipalName in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

createTemplate

public CreateTemplateResult createTemplate(CreateTemplateRequest request)

Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.

Specified by:

createTemplate in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

createTemplateGroupAccessControlEntry

public CreateTemplateGroupAccessControlEntryResult createTemplateGroupAccessControlEntry(CreateTemplateGroupAccessControlEntryRequest request)

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).

Specified by:

createTemplateGroupAccessControlEntry in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

deleteConnector

public DeleteConnectorResult deleteConnector(DeleteConnectorRequest request)

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.

Specified by:

deleteConnector in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

deleteDirectoryRegistration

public DeleteDirectoryRegistrationResult deleteDirectoryRegistration(DeleteDirectoryRegistrationRequest request)

Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

Specified by:

deleteDirectoryRegistration in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

deleteServicePrincipalName

public DeleteServicePrincipalNameResult deleteServicePrincipalName(DeleteServicePrincipalNameRequest request)

Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.

Specified by:

deleteServicePrincipalName in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

deleteTemplate

public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)

Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.

Specified by:

deleteTemplate in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

deleteTemplateGroupAccessControlEntry

public DeleteTemplateGroupAccessControlEntryResult deleteTemplateGroupAccessControlEntry(DeleteTemplateGroupAccessControlEntryRequest request)

Deletes a group access control entry.

Specified by:

deleteTemplateGroupAccessControlEntry in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

getConnector

public GetConnectorResult getConnector(GetConnectorRequest request)

Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).

Specified by:

getConnector in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

getDirectoryRegistration

public GetDirectoryRegistrationResult getDirectoryRegistration(GetDirectoryRegistrationRequest request)

A structure that contains information about your directory registration.

Specified by:

getDirectoryRegistration in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

getServicePrincipalName

public GetServicePrincipalNameResult getServicePrincipalName(GetServicePrincipalNameRequest request)

Lists the service principal name that the connector uses to authenticate with Active Directory.

Specified by:

getServicePrincipalName in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

getTemplate

public GetTemplateResult getTemplate(GetTemplateRequest request)

Retrieves a certificate template that the connector uses to issue certificates from a private CA.

Specified by:

getTemplate in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

getTemplateGroupAccessControlEntry

public GetTemplateGroupAccessControlEntryResult getTemplateGroupAccessControlEntry(GetTemplateGroupAccessControlEntryRequest request)

Retrieves the group access control entries for a template.

Specified by:

getTemplateGroupAccessControlEntry in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

listConnectors

public ListConnectorsResult listConnectors(ListConnectorsRequest request)

Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.

Specified by:

listConnectors in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

listDirectoryRegistrations

public ListDirectoryRegistrationsResult listDirectoryRegistrations(ListDirectoryRegistrationsRequest request)

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.

Specified by:

listDirectoryRegistrations in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

listServicePrincipalNames

public ListServicePrincipalNamesResult listServicePrincipalNames(ListServicePrincipalNamesRequest request)

Lists the service principal names that the connector uses to authenticate with Active Directory.

Specified by:

listServicePrincipalNames in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags, if any, that are associated with your resource.

Specified by:

listTagsForResource in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

listTemplateGroupAccessControlEntries

public ListTemplateGroupAccessControlEntriesResult listTemplateGroupAccessControlEntries(ListTemplateGroupAccessControlEntriesRequest request)

Lists group access control entries you created.

Specified by:

listTemplateGroupAccessControlEntries in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

listTemplates

public ListTemplatesResult listTemplates(ListTemplatesRequest request)

Lists the templates, if any, that are associated with a connector.

Specified by:

listTemplates in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to your resource.

Specified by:

tagResource in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from your resource.

Specified by:

untagResource in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

updateTemplate

public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)

Update template configuration to define the information included in certificates.

Specified by:

updateTemplate in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

updateTemplateGroupAccessControlEntry

public UpdateTemplateGroupAccessControlEntryResult updateTemplateGroupAccessControlEntry(UpdateTemplateGroupAccessControlEntryRequest request)

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

Specified by:

updateTemplateGroupAccessControlEntry in interface AWSPcaConnectorAd

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSPcaConnectorAd

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSPcaConnectorAd

Overrides:

shutdown in class AmazonWebServiceClient