EVS / Client / delete_environment_connector

delete_environment_connector

EVS.Client.delete_environment_connector(**kwargs)

Deletes a connector from an Amazon EVS environment.

Note

Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment_connector(
    clientToken='string',
    environmentId='string',
    connectorId='string'
)

Parameters:

• clientToken (string) –

  Note

  This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

  This field is autopopulated if not provided.

• environmentId (string) –

  [REQUIRED]

  A unique ID for the environment that the connector belongs to.

• connectorId (string) –

  [REQUIRED]

  A unique ID for the connector to be deleted.

Return type:

dict

Returns:

Response Syntax

{
    'connector': {
        '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)
    },
    'environmentSummary': {
        'environmentId': 'string',
        'environmentName': 'string',
        'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2',
        'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
        'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1),
        'environmentArn': 'string'
    }
}

Response Structure

• (dict) –

  • connector (dict) –

    A description of the deleted connector.

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

  • environmentSummary (dict) –

    A summary of the environment that the connector was deleted from.

    • environmentId (string) –

      A unique ID for the environment.

    • environmentName (string) –

      The name of the environment.

    • vcfVersion (string) –

      The VCF version of the environment.

    • environmentStatus (string) –

      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

    • environmentState (string) –

      The state of an environment.

    • createdAt (datetime) –

      The date and time that the environment was created.

    • modifiedAt (datetime) –

      The date and time that the environment was modified.

    • environmentArn (string) –

      The Amazon Resource Name (ARN) that is associated with the environment.

Exceptions

• EVS.Client.exceptions.ThrottlingException

• EVS.Client.exceptions.ValidationException

• EVS.Client.exceptions.ResourceNotFoundException