PcaConnectorAd / Paginator / ListConnectors

ListConnectors

class PcaConnectorAd.Paginator.ListConnectors

paginator = client.get_paginator('list_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PcaConnectorAd.Client.list_connectors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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',
                ]
            }
        },
    ],

}

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