DataZone / Client / create_environment_action

create_environment_action#

DataZone.Client.create_environment_action(**kwargs)#

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

See also: AWS API Documentation

Request Syntax

response = client.create_environment_action(
    description='string',
    domainIdentifier='string',
    environmentIdentifier='string',
    name='string',
    parameters={
        'awsConsoleLink': {
            'uri': 'string'
        }
    }
)
Parameters:

  • description (string) – The description of the environment action that is being created in the environment.

  • domainIdentifier (string) –

    [REQUIRED]

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

  • environmentIdentifier (string) –

    [REQUIRED]

    The ID of the environment in which the environment action is created.

  • name (string) –

    [REQUIRED]

    The name of the environment action.

  • parameters (dict) –

    [REQUIRED]

    The parameters of the environment action.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: awsConsoleLink.

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

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 domain in which the environment action is created.

    • environmentId (string) –

      The ID of the environment in which the environment is created.

    • 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

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.ResourceNotFoundException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ConflictException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException