DataZone / Client / list_environment_actions

list_environment_actions¶

DataZone.Client.list_environment_actions(**kwargs)¶

Lists existing environment actions.

Request Syntax

response = client.list_environment_actions(
    domainIdentifier='string',
    environmentIdentifier='string',
    maxResults=123,
    nextToken='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.
maxResults (integer) – The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentActions to list the next set of environment actions.
nextToken (string) – When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

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) –
  
  When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException