EVS / Client / list_environments

list_environments

EVS.Client.list_environments(**kwargs)

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
    nextToken='string',
    maxResults=123,
    state=[
        'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
    ]
)
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.

  • state (list) –

    The state of an environment. Used to filter response results to return only environments with the specified environmentState.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'environmentSummaries': [
        {
            'environmentId': 'string',
            'environmentName': 'string',
            'vcfVersion': 'VCF-5.2.1',
            '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) –

    • nextToken (string) –

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

    • environmentSummaries (list) –

      A list of environments with summarized environment details.

      • (dict) –

        A list of environments with summarized environment details.

        • 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