drs / Client / put_launch_action

put_launch_action#

drs.Client.put_launch_action(**kwargs)#

Puts a resource launch action.

See also: AWS API Documentation

Request Syntax

response = client.put_launch_action(
    actionCode='string',
    actionId='string',
    actionVersion='string',
    active=True|False,
    category='MONITORING'|'VALIDATION'|'CONFIGURATION'|'SECURITY'|'OTHER',
    description='string',
    name='string',
    optional=True|False,
    order=123,
    parameters={
        'string': {
            'type': 'SSM_STORE'|'DYNAMIC',
            'value': 'string'
        }
    },
    resourceId='string'
)
Parameters:

  • actionCode (string) –

    [REQUIRED]

    Launch action code.

  • actionId (string) –

    [REQUIRED]

    Launch action Id.

  • actionVersion (string) –

    [REQUIRED]

    Launch action version.

  • active (boolean) –

    [REQUIRED]

    Whether the launch action is active.

  • category (string) –

    [REQUIRED]

    Launch action category.

  • description (string) –

    [REQUIRED]

    Launch action description.

  • name (string) –

    [REQUIRED]

    Launch action name.

  • optional (boolean) –

    [REQUIRED]

    Whether the launch will not be marked as failed if this action fails.

  • order (integer) –

    [REQUIRED]

    Launch action order.

  • parameters (dict) –

    Launch action parameters.

    • (string) –

      • (dict) –

        Launch action parameter.

        • type (string) –

          Type.

        • value (string) –

          Value.

  • resourceId (string) –

    [REQUIRED]

    Launch configuration template Id or Source Server Id

Return type:

dict

Returns:

Response Syntax

{
    'actionCode': 'string',
    'actionId': 'string',
    'actionVersion': 'string',
    'active': True|False,
    'category': 'MONITORING'|'VALIDATION'|'CONFIGURATION'|'SECURITY'|'OTHER',
    'description': 'string',
    'name': 'string',
    'optional': True|False,
    'order': 123,
    'parameters': {
        'string': {
            'type': 'SSM_STORE'|'DYNAMIC',
            'value': 'string'
        }
    },
    'resourceId': 'string',
    'type': 'SSM_AUTOMATION'|'SSM_COMMAND'
}

Response Structure

  • (dict) –

    • actionCode (string) –

      Launch action code.

    • actionId (string) –

      Launch action Id.

    • actionVersion (string) –

      Launch action version.

    • active (boolean) –

      Whether the launch action is active.

    • category (string) –

      Launch action category.

    • description (string) –

      Launch action description.

    • name (string) –

      Launch action name.

    • optional (boolean) –

      Whether the launch will not be marked as failed if this action fails.

    • order (integer) –

      Launch action order.

    • parameters (dict) –

      Launch action parameters.

      • (string) –

        • (dict) –

          Launch action parameter.

          • type (string) –

            Type.

          • value (string) –

            Value.

    • resourceId (string) –

      Launch configuration template Id or Source Server Id

    • type (string) –

      Launch action type.

Exceptions