DataZone / Client / get_environment_action

get_environment_action#

DataZone.Client.get_environment_action(**kwargs)#

Gets the specified environment action.

See also: AWS API Documentation

Request Syntax

response = client.get_environment_action(
    domainIdentifier='string',
    environmentIdentifier='string',
    identifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is invoked.

  • environmentIdentifier (string) –

    [REQUIRED]

    The environment ID of the environment action.

  • identifier (string) –

    [REQUIRED]

    The ID of the environment action

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'domainId': 'string',
    'environmentId': 'string',
    'id': 'string',
    'name': 'string',
    'parameters': {
        'awsConsoleLink': {
            'uri': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • description (string) –

      The description of the environment action.

    • domainId (string) –

      The ID of the Amazon DataZone domain in which the environment action lives.

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

Exceptions