PcaConnectorAd / Client / list_connectors

list_connectors#

PcaConnectorAd.Client.list_connectors(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_connectors(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

  • NextToken (string) – Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

Return type:

dict

Returns:

Response Syntax

{
    'Connectors': [
        {
            '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',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Connectors (list) –

      Summary information about each connector you have created.

      • (dict) –

        Summary description of the Amazon Web Services Private CA AD connectors belonging to an Amazon Web Services account.

        • 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 to request 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) –

    • NextToken (string) –

      Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

Exceptions