com.amazonaws.services.pcaconnectorad

Interface AWSPcaConnectorAd

All Known Subinterfaces:

AWSPcaConnectorAdAsync

All Known Implementing Classes:

AbstractAWSPcaConnectorAd, AbstractAWSPcaConnectorAdAsync, AWSPcaConnectorAdAsyncClient, AWSPcaConnectorAdClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPcaConnectorAd

Interface for accessing PcaConnectorAd.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSPcaConnectorAd instead.

Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that enables you to provision security certificates for AD signed by a private CA that you own. For more information, see Amazon Web Services Private CA Connector for Active Directory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateConnectorResult	createConnector(CreateConnectorRequest createConnectorRequest) Creates a connector between Amazon Web Services Private CA and an Active Directory.
CreateDirectoryRegistrationResult	createDirectoryRegistration(CreateDirectoryRegistrationRequest createDirectoryRegistrationRequest) Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
CreateServicePrincipalNameResult	createServicePrincipalName(CreateServicePrincipalNameRequest createServicePrincipalNameRequest) Creates a service principal name (SPN) for the service account in Active Directory.
CreateTemplateResult	createTemplate(CreateTemplateRequest createTemplateRequest) Creates an Active Directory compatible certificate template.
CreateTemplateGroupAccessControlEntryResult	createTemplateGroupAccessControlEntry(CreateTemplateGroupAccessControlEntryRequest createTemplateGroupAccessControlEntryRequest) Create a group access control entry.
DeleteConnectorResult	deleteConnector(DeleteConnectorRequest deleteConnectorRequest) Deletes a connector for Active Directory.
DeleteDirectoryRegistrationResult	deleteDirectoryRegistration(DeleteDirectoryRegistrationRequest deleteDirectoryRegistrationRequest) Deletes a directory registration.
DeleteServicePrincipalNameResult	deleteServicePrincipalName(DeleteServicePrincipalNameRequest deleteServicePrincipalNameRequest) Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
DeleteTemplateResult	deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) Deletes a template.
DeleteTemplateGroupAccessControlEntryResult	deleteTemplateGroupAccessControlEntry(DeleteTemplateGroupAccessControlEntryRequest deleteTemplateGroupAccessControlEntryRequest) 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 getConnectorRequest) Lists information about your connector.
GetDirectoryRegistrationResult	getDirectoryRegistration(GetDirectoryRegistrationRequest getDirectoryRegistrationRequest) A structure that contains information about your directory registration.
GetServicePrincipalNameResult	getServicePrincipalName(GetServicePrincipalNameRequest getServicePrincipalNameRequest) Lists the service principal name that the connector uses to authenticate with Active Directory.
GetTemplateResult	getTemplate(GetTemplateRequest getTemplateRequest) Retrieves a certificate template that the connector uses to issue certificates from a private CA.
GetTemplateGroupAccessControlEntryResult	getTemplateGroupAccessControlEntry(GetTemplateGroupAccessControlEntryRequest getTemplateGroupAccessControlEntryRequest) Retrieves the group access control entries for a template.
ListConnectorsResult	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.
ListDirectoryRegistrationsResult	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.
ListServicePrincipalNamesResult	listServicePrincipalNames(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest) Lists the service principal names that the connector uses to authenticate with Active Directory.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags, if any, that are associated with your resource.
ListTemplateGroupAccessControlEntriesResult	listTemplateGroupAccessControlEntries(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest) Lists group access control entries you created.
ListTemplatesResult	listTemplates(ListTemplatesRequest listTemplatesRequest) 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 tagResourceRequest) Adds one or more tags to your resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from your resource.
UpdateTemplateResult	updateTemplate(UpdateTemplateRequest updateTemplateRequest) Update template configuration to define the information included in certificates.
UpdateTemplateGroupAccessControlEntryResult	updateTemplateGroupAccessControlEntry(UpdateTemplateGroupAccessControlEntryRequest updateTemplateGroupAccessControlEntryRequest) Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createConnector

CreateConnectorResult createConnector(CreateConnectorRequest createConnectorRequest)

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

Parameters:

createConnectorRequest -

Returns:

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

CreateDirectoryRegistrationResult createDirectoryRegistration(CreateDirectoryRegistrationRequest createDirectoryRegistrationRequest)

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

Parameters:

createDirectoryRegistrationRequest -

Returns:

Result of the CreateDirectoryRegistration operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

createServicePrincipalName

CreateServicePrincipalNameResult createServicePrincipalName(CreateServicePrincipalNameRequest createServicePrincipalNameRequest)

Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.

Parameters:

createServicePrincipalNameRequest -

Returns:

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

CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest)

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

Parameters:

createTemplateRequest -

Returns:

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

CreateTemplateGroupAccessControlEntryResult createTemplateGroupAccessControlEntry(CreateTemplateGroupAccessControlEntryRequest createTemplateGroupAccessControlEntryRequest)

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).

Parameters:

createTemplateGroupAccessControlEntryRequest -

Returns:

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

DeleteConnectorResult deleteConnector(DeleteConnectorRequest deleteConnectorRequest)

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.

Parameters:

deleteConnectorRequest -

Returns:

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

DeleteDirectoryRegistrationResult deleteDirectoryRegistration(DeleteDirectoryRegistrationRequest deleteDirectoryRegistrationRequest)

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

Parameters:

deleteDirectoryRegistrationRequest -

Returns:

Result of the DeleteDirectoryRegistration operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

deleteServicePrincipalName

DeleteServicePrincipalNameResult deleteServicePrincipalName(DeleteServicePrincipalNameRequest deleteServicePrincipalNameRequest)

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

Parameters:

deleteServicePrincipalNameRequest -

Returns:

Result of the DeleteServicePrincipalName operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

deleteTemplate

DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)

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

Parameters:

deleteTemplateRequest -

Returns:

Result of the DeleteTemplate operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

deleteTemplateGroupAccessControlEntry

DeleteTemplateGroupAccessControlEntryResult deleteTemplateGroupAccessControlEntry(DeleteTemplateGroupAccessControlEntryRequest deleteTemplateGroupAccessControlEntryRequest)

Deletes a group access control entry.

Parameters:

deleteTemplateGroupAccessControlEntryRequest -

Returns:

Result of the DeleteTemplateGroupAccessControlEntry operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

getConnector

GetConnectorResult getConnector(GetConnectorRequest getConnectorRequest)

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

Parameters:

getConnectorRequest -

Returns:

Result of the GetConnector operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

getDirectoryRegistration

GetDirectoryRegistrationResult getDirectoryRegistration(GetDirectoryRegistrationRequest getDirectoryRegistrationRequest)

A structure that contains information about your directory registration.

Parameters:

getDirectoryRegistrationRequest -

Returns:

Result of the GetDirectoryRegistration operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

getServicePrincipalName

GetServicePrincipalNameResult getServicePrincipalName(GetServicePrincipalNameRequest getServicePrincipalNameRequest)

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

Parameters:

getServicePrincipalNameRequest -

Returns:

Result of the GetServicePrincipalName operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

getTemplate

GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)

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

Parameters:

getTemplateRequest -

Returns:

Result of the GetTemplate operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

getTemplateGroupAccessControlEntry

GetTemplateGroupAccessControlEntryResult getTemplateGroupAccessControlEntry(GetTemplateGroupAccessControlEntryRequest getTemplateGroupAccessControlEntryRequest)

Retrieves the group access control entries for a template.

Parameters:

getTemplateGroupAccessControlEntryRequest -

Returns:

Result of the GetTemplateGroupAccessControlEntry operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

listConnectors

ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest)

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

Parameters:

listConnectorsRequest -

Returns:

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

ListDirectoryRegistrationsResult listDirectoryRegistrations(ListDirectoryRegistrationsRequest listDirectoryRegistrationsRequest)

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

Parameters:

listDirectoryRegistrationsRequest -

Returns:

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

ListServicePrincipalNamesResult listServicePrincipalNames(ListServicePrincipalNamesRequest listServicePrincipalNamesRequest)

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

Parameters:

listServicePrincipalNamesRequest -

Returns:

Result of the ListServicePrincipalNames operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

listTemplateGroupAccessControlEntries

ListTemplateGroupAccessControlEntriesResult listTemplateGroupAccessControlEntries(ListTemplateGroupAccessControlEntriesRequest listTemplateGroupAccessControlEntriesRequest)

Lists group access control entries you created.

Parameters:

listTemplateGroupAccessControlEntriesRequest -

Returns:

Result of the ListTemplateGroupAccessControlEntries operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

listTemplates

ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)

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

Parameters:

listTemplatesRequest -

Returns:

Result of the ListTemplates operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds one or more tags to your resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from your resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

updateTemplate

UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest)

Update template configuration to define the information included in certificates.

Parameters:

updateTemplateRequest -

Returns:

Result of the UpdateTemplate operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

updateTemplateGroupAccessControlEntry

UpdateTemplateGroupAccessControlEntryResult updateTemplateGroupAccessControlEntry(UpdateTemplateGroupAccessControlEntryRequest updateTemplateGroupAccessControlEntryRequest)

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

Parameters:

updateTemplateGroupAccessControlEntryRequest -

Returns:

Result of the UpdateTemplateGroupAccessControlEntry operation returned by the service.

Throws:

AccessDeniedException - You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

ValidationException - An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

ResourceNotFoundException - The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

ThrottlingException - The limit on the number of requests per second was exceeded.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

ConflictException - This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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