Skip to content

PcaConnectorAdClient#

Index > PcaConnectorAd > PcaConnectorAdClient

Auto-generated documentation for PcaConnectorAd type annotations stubs module mypy-boto3-pca-connector-ad.

PcaConnectorAdClient#

Type annotations and code completion for boto3.client("pca-connector-ad"). boto3 documentation

# PcaConnectorAdClient usage example

from boto3.session import Session
from mypy_boto3_pca_connector_ad.client import PcaConnectorAdClient

def get_pca-connector-ad_client() -> PcaConnectorAdClient:
    return Session().client("pca-connector-ad")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("pca-connector-ad").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("pca-connector-ad")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_pca_connector_ad.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("pca-connector-ad").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("pca-connector-ad").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_connector#

Creates a connector between Amazon Web Services Private CA and an Active Directory.

Type annotations and code completion for boto3.client("pca-connector-ad").create_connector method. boto3 documentation

# create_connector method definition

def create_connector(
    self,
    *,
    CertificateAuthorityArn: str,
    DirectoryId: str,
    VpcInformation: VpcInformationTypeDef,  # (1)
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateConnectorResponseTypeDef:  # (2)
    ...
  1. See VpcInformationTypeDef
  2. See CreateConnectorResponseTypeDef 
# create_connector method usage example with argument unpacking

kwargs: CreateConnectorRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityArn": ...,
    "DirectoryId": ...,
    "VpcInformation": ...,
}

parent.create_connector(**kwargs)
  1. See CreateConnectorRequestRequestTypeDef

create_directory_registration#

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory See also: AWS API Documentation.

Type annotations and code completion for boto3.client("pca-connector-ad").create_directory_registration method. boto3 documentation

# create_directory_registration method definition

def create_directory_registration(
    self,
    *,
    DirectoryId: str,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateDirectoryRegistrationResponseTypeDef:  # (1)
    ...
  1. See CreateDirectoryRegistrationResponseTypeDef 
# create_directory_registration method usage example with argument unpacking

kwargs: CreateDirectoryRegistrationRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.create_directory_registration(**kwargs)
  1. See CreateDirectoryRegistrationRequestRequestTypeDef

create_service_principal_name#

Creates a service principal name (SPN) for the service account in Active Directory.

Type annotations and code completion for boto3.client("pca-connector-ad").create_service_principal_name method. boto3 documentation

# create_service_principal_name method definition

def create_service_principal_name(
    self,
    *,
    ConnectorArn: str,
    DirectoryRegistrationArn: str,
    ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# create_service_principal_name method usage example with argument unpacking

kwargs: CreateServicePrincipalNameRequestRequestTypeDef = {  # (1)
    "ConnectorArn": ...,
    "DirectoryRegistrationArn": ...,
}

parent.create_service_principal_name(**kwargs)
  1. See CreateServicePrincipalNameRequestRequestTypeDef

create_template#

Creates an Active Directory compatible certificate template.

Type annotations and code completion for boto3.client("pca-connector-ad").create_template method. boto3 documentation

# create_template method definition

def create_template(
    self,
    *,
    ConnectorArn: str,
    Definition: TemplateDefinitionTypeDef,  # (1)
    Name: str,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateTemplateResponseTypeDef:  # (2)
    ...
  1. See TemplateDefinitionTypeDef
  2. See CreateTemplateResponseTypeDef 
# create_template method usage example with argument unpacking

kwargs: CreateTemplateRequestRequestTypeDef = {  # (1)
    "ConnectorArn": ...,
    "Definition": ...,
    "Name": ...,
}

parent.create_template(**kwargs)
  1. See CreateTemplateRequestRequestTypeDef

create_template_group_access_control_entry#

Create a group access control entry.

Type annotations and code completion for boto3.client("pca-connector-ad").create_template_group_access_control_entry method. boto3 documentation

# create_template_group_access_control_entry method definition

def create_template_group_access_control_entry(
    self,
    *,
    AccessRights: AccessRightsTypeDef,  # (1)
    GroupDisplayName: str,
    GroupSecurityIdentifier: str,
    TemplateArn: str,
    ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See AccessRightsTypeDef
  2. See EmptyResponseMetadataTypeDef 
# create_template_group_access_control_entry method usage example with argument unpacking

kwargs: CreateTemplateGroupAccessControlEntryRequestRequestTypeDef = {  # (1)
    "AccessRights": ...,
    "GroupDisplayName": ...,
    "GroupSecurityIdentifier": ...,
    "TemplateArn": ...,
}

parent.create_template_group_access_control_entry(**kwargs)
  1. See CreateTemplateGroupAccessControlEntryRequestRequestTypeDef

delete_connector#

Deletes a connector for Active Directory.

Type annotations and code completion for boto3.client("pca-connector-ad").delete_connector method. boto3 documentation

# delete_connector method definition

def delete_connector(
    self,
    *,
    ConnectorArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_connector method usage example with argument unpacking

kwargs: DeleteConnectorRequestRequestTypeDef = {  # (1)
    "ConnectorArn": ...,
}

parent.delete_connector(**kwargs)
  1. See DeleteConnectorRequestRequestTypeDef

delete_directory_registration#

Deletes a directory registration.

Type annotations and code completion for boto3.client("pca-connector-ad").delete_directory_registration method. boto3 documentation

# delete_directory_registration method definition

def delete_directory_registration(
    self,
    *,
    DirectoryRegistrationArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_directory_registration method usage example with argument unpacking

kwargs: DeleteDirectoryRegistrationRequestRequestTypeDef = {  # (1)
    "DirectoryRegistrationArn": ...,
}

parent.delete_directory_registration(**kwargs)
  1. See DeleteDirectoryRegistrationRequestRequestTypeDef

delete_service_principal_name#

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

Type annotations and code completion for boto3.client("pca-connector-ad").delete_service_principal_name method. boto3 documentation

# delete_service_principal_name method definition

def delete_service_principal_name(
    self,
    *,
    ConnectorArn: str,
    DirectoryRegistrationArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_service_principal_name method usage example with argument unpacking

kwargs: DeleteServicePrincipalNameRequestRequestTypeDef = {  # (1)
    "ConnectorArn": ...,
    "DirectoryRegistrationArn": ...,
}

parent.delete_service_principal_name(**kwargs)
  1. See DeleteServicePrincipalNameRequestRequestTypeDef

delete_template#

Deletes a template.

Type annotations and code completion for boto3.client("pca-connector-ad").delete_template method. boto3 documentation

# delete_template method definition

def delete_template(
    self,
    *,
    TemplateArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_template method usage example with argument unpacking

kwargs: DeleteTemplateRequestRequestTypeDef = {  # (1)
    "TemplateArn": ...,
}

parent.delete_template(**kwargs)
  1. See DeleteTemplateRequestRequestTypeDef

delete_template_group_access_control_entry#

Deletes a group access control entry.

Type annotations and code completion for boto3.client("pca-connector-ad").delete_template_group_access_control_entry method. boto3 documentation

# delete_template_group_access_control_entry method definition

def delete_template_group_access_control_entry(
    self,
    *,
    GroupSecurityIdentifier: str,
    TemplateArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_template_group_access_control_entry method usage example with argument unpacking

kwargs: DeleteTemplateGroupAccessControlEntryRequestRequestTypeDef = {  # (1)
    "GroupSecurityIdentifier": ...,
    "TemplateArn": ...,
}

parent.delete_template_group_access_control_entry(**kwargs)
  1. See DeleteTemplateGroupAccessControlEntryRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("pca-connector-ad").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_connector#

Lists information about your connector.

Type annotations and code completion for boto3.client("pca-connector-ad").get_connector method. boto3 documentation

# get_connector method definition

def get_connector(
    self,
    *,
    ConnectorArn: str,
) -> GetConnectorResponseTypeDef:  # (1)
    ...
  1. See GetConnectorResponseTypeDef 
# get_connector method usage example with argument unpacking

kwargs: GetConnectorRequestRequestTypeDef = {  # (1)
    "ConnectorArn": ...,
}

parent.get_connector(**kwargs)
  1. See GetConnectorRequestRequestTypeDef

get_directory_registration#

A structure that contains information about your directory registration.

Type annotations and code completion for boto3.client("pca-connector-ad").get_directory_registration method. boto3 documentation

# get_directory_registration method definition

def get_directory_registration(
    self,
    *,
    DirectoryRegistrationArn: str,
) -> GetDirectoryRegistrationResponseTypeDef:  # (1)
    ...
  1. See GetDirectoryRegistrationResponseTypeDef 
# get_directory_registration method usage example with argument unpacking

kwargs: GetDirectoryRegistrationRequestRequestTypeDef = {  # (1)
    "DirectoryRegistrationArn": ...,
}

parent.get_directory_registration(**kwargs)
  1. See GetDirectoryRegistrationRequestRequestTypeDef

get_service_principal_name#

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

Type annotations and code completion for boto3.client("pca-connector-ad").get_service_principal_name method. boto3 documentation

# get_service_principal_name method definition

def get_service_principal_name(
    self,
    *,
    ConnectorArn: str,
    DirectoryRegistrationArn: str,
) -> GetServicePrincipalNameResponseTypeDef:  # (1)
    ...
  1. See GetServicePrincipalNameResponseTypeDef 
# get_service_principal_name method usage example with argument unpacking

kwargs: GetServicePrincipalNameRequestRequestTypeDef = {  # (1)
    "ConnectorArn": ...,
    "DirectoryRegistrationArn": ...,
}

parent.get_service_principal_name(**kwargs)
  1. See GetServicePrincipalNameRequestRequestTypeDef

get_template#

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

Type annotations and code completion for boto3.client("pca-connector-ad").get_template method. boto3 documentation

# get_template method definition

def get_template(
    self,
    *,
    TemplateArn: str,
) -> GetTemplateResponseTypeDef:  # (1)
    ...
  1. See GetTemplateResponseTypeDef 
# get_template method usage example with argument unpacking

kwargs: GetTemplateRequestRequestTypeDef = {  # (1)
    "TemplateArn": ...,
}

parent.get_template(**kwargs)
  1. See