EVS / Client / list_environment_connectors

list_environment_connectors

EVS.Client.list_environment_connectors(**kwargs)

Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_connectors(
    nextToken='string',
    maxResults=123,
    environmentId='string'
)

Parameters:

• nextToken (string) – A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

• maxResults (integer) – The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

• environmentId (string) –

  [REQUIRED]

  A unique ID for the environment.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'connectors': [
        {
            'environmentId': 'string',
            'connectorId': 'string',
            'type': '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',
                    'result': 'PASSED'|'FAILED'|'UNKNOWN',
                    'lastCheckAttempt': datetime(2015, 1, 1),
                    'impairedSince': datetime(2015, 1, 1)
                },
            ],
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    A unique pagination token for next page results. Make the call again using this token to retrieve the next page.

  • 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 vCenter connection 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.

Exceptions

• EVS.Client.exceptions.ValidationException

• EVS.Client.exceptions.ResourceNotFoundException