DataZone / Paginator / ListEnvironmentActions

ListEnvironmentActions

class DataZone.Paginator.ListEnvironmentActions

paginator = client.get_paginator('list_environment_actions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_environment_actions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the Amazon DataZone domain in which the environment actions are listed.

• environmentIdentifier (string) –

  [REQUIRED]

  The ID of the envrironment whose environment actions are listed.

• 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

{
    'items': [
        {
            'description': 'string',
            'domainId': 'string',
            'environmentId': 'string',
            'id': 'string',
            'name': 'string',
            'parameters': {
                'awsConsoleLink': {
                    'uri': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of ListEnvironmentActions.

    • (dict) –

      The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment.

      • description (string) –

        The environment action description.

      • domainId (string) –

        The Amazon DataZone domain ID of the environment action.

      • environmentId (string) –

        The environment ID of the environment action.

      • id (string) –

        The ID of the environment action.

      • name (string) –

        The name of the environment action.

      • parameters (dict) –

        The parameters of the environment action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: awsConsoleLink. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • awsConsoleLink (dict) –

          The console link specified as part of the environment action.

          • uri (string) –

            The URI of the console link specified as part of the environment action.

  • NextToken (string) –

    A token to resume pagination.