PcaConnectorAd / Client / get_connector

get_connector#

PcaConnectorAd.Client.get_connector(**kwargs)#

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

Request Syntax

response = client.get_connector(
    ConnectorArn='string'
)

Parameters:

ConnectorArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

Return type:

dict

Returns:

Response Syntax

{
    'Connector': {
        'Arn': 'string',
        'CertificateAuthorityArn': 'string',
        'CertificateEnrollmentPolicyServerEndpoint': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'DirectoryId': 'string',
        'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'StatusReason': 'DIRECTORY_ACCESS_DENIED'|'INTERNAL_FAILURE'|'PRIVATECA_ACCESS_DENIED'|'PRIVATECA_RESOURCE_NOT_FOUND'|'SECURITY_GROUP_NOT_IN_VPC'|'VPC_ACCESS_DENIED'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'VPC_RESOURCE_NOT_FOUND',
        'UpdatedAt': datetime(2015, 1, 1),
        'VpcInformation': {
            'SecurityGroupIds': [
                'string',
            ]
        }
    }
}

Response Structure

(dict) –
- Connector (dict) –
  
  A structure that contains information about your connector.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
  - CertificateAuthorityArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate authority being used.
  - CertificateEnrollmentPolicyServerEndpoint (string) –
    
    Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when requesting certificates.
  - CreatedAt (datetime) –
    
    The date and time that the connector was created.
  - DirectoryId (string) –
    
    The identifier of the Active Directory.
  - Status (string) –
    
    Status of the connector. Status can be creating, active, deleting, or failed.
  - StatusReason (string) –
    
    Additional information about the connector status if the status is failed.
  - UpdatedAt (datetime) –
    
    The date and time that the connector was updated.
  - VpcInformation (dict) –
    
    Information of the VPC and security group(s) used with the connector.
    - SecurityGroupIds (list) –
      
      The security groups used with the connector. You can use a maximum of 4 security groups with a connector.
      - (string) –

Exceptions

PcaConnectorAd.Client.exceptions.AccessDeniedException
PcaConnectorAd.Client.exceptions.ValidationException
PcaConnectorAd.Client.exceptions.ResourceNotFoundException
PcaConnectorAd.Client.exceptions.ThrottlingException
PcaConnectorAd.Client.exceptions.InternalServerException