EVS / Paginator / ListEnvironmentConnectors

ListEnvironmentConnectors

class EVS.Paginator.ListEnvironmentConnectors

paginator = client.get_paginator('list_environment_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EVS.Client.list_environment_connectors().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• environmentId (string) –

  [REQUIRED]

  A unique ID for the environment.

• 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': [
        {
            'environmentId': 'string',
            'connectorId': 'string',
            'type': 'OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
            'applianceFqdn': 'string',
            'secretArn': 'string',
            'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED',
            'stateDetails': 'string',
            'status': 'PASSED'|'FAILED'|'UNKNOWN',
            'checks': [
                {
                    'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
                    'result': 'PASSED'|'FAILED'|'UNKNOWN',
                    'lastCheckAttempt': datetime(2015, 1, 1),
                    'impairedSince': datetime(2015, 1, 1)
                },
            ],
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • connectors (list) –

    A list of connectors in the environment.

    • (dict) –

      An object that represents a connector for an Amazon EVS environment. A connector establishes a connection to the given appliance type using the credentials stored in Amazon Web Services Secrets Manager.

      • environmentId (string) –

        The unique ID of the environment that the connector belongs to.

      • connectorId (string) –

        The unique ID of the connector.

      • type (string) –

        The type of the connector.

      • applianceFqdn (string) –

        The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

      • secretArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

      • state (string) –

        The state of the connector.

      • stateDetails (string) –

        A detailed description of the connector state.

      • status (string) –

        The status of the connector.

      • checks (list) –

        A list of checks that are run on the connector.

        • (dict) –

          A check on a connector to identify connectivity health.

          • type (string) –

            The check type.

          • result (string) –

            The check result.

          • lastCheckAttempt (datetime) –

            The date and time of the last check attempt.

          • impairedSince (datetime) –

            The time when connector health began to be impaired.

      • createdAt (datetime) –

        The date and time that the connector was created.

      • modifiedAt (datetime) –

        The date and time that the connector was modified.

  • NextToken (string) –

    A token to resume pagination.