:doc:`DataZone <../../datazone>` / Client / list_environment_actions

************************
list_environment_actions
************************



.. py:method:: DataZone.Client.list_environment_actions(**kwargs)

  

  Lists existing environment actions.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListEnvironmentActions>`_  


  **Request Syntax**
  ::

    response = client.list_environment_actions(
        domainIdentifier='string',
        environmentIdentifier='string',
        nextToken='string',
        maxResults=123
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

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

    

  
  :type environmentIdentifier: string
  :param environmentIdentifier: **[REQUIRED]** 

    The ID of the envrironment whose environment actions are listed.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  :type maxResults: integer
  :param maxResults: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'items': [
              {
                  'domainId': 'string',
                  'environmentId': 'string',
                  'id': 'string',
                  'name': 'string',
                  'parameters': {
                      'awsConsoleLink': {
                          'uri': 'string'
                      }
                  },
                  'description': '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.

          
          

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

                
          
        
          

          - **description** *(string) --* 

            The environment action description.

            
      
    
      

      - **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**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  