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(
    resourceId='string',
    actionCode='string',
    order=123,
    actionId='string',
    optional=True|False,
    active=True|False,
    name='string',
    actionVersion='string',
    category='MONITORING'|'VALIDATION'|'CONFIGURATION'|'SECURITY'|'OTHER',
    parameters={
        'string': {
            'value': 'string',
            'type': 'SSM_STORE'|'DYNAMIC'
        }
    },
    description='string'
)

Parameters:

• resourceId (string) –

  [REQUIRED]

  Launch configuration template Id or Source Server Id

• actionCode (string) –

  [REQUIRED]

  Launch action code.

• order (integer) –

  [REQUIRED]

  Launch action order.

• actionId (string) –

  [REQUIRED]

  Launch action Id.

• optional (boolean) –

  [REQUIRED]

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

• active (boolean) –

  [REQUIRED]

  Whether the launch action is active.

• name (string) –

  [REQUIRED]

  Launch action name.

• actionVersion (string) –

  [REQUIRED]

  Launch action version.

• category (string) –

  [REQUIRED]

  Launch action category.

• parameters (dict) –

  Launch action parameters.

  • (string) –

    • (dict) –

      Launch action parameter.

      • value (string) –

        Value.

      • type (string) –

        Type.

• description (string) –

  [REQUIRED]

  Launch action description.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • resourceId (string) –

    Launch configuration template Id or Source Server Id

  • actionId (string) –

    Launch action Id.

  • actionCode (string) –

    Launch action code.

  • type (string) –

    Launch action type.

  • name (string) –

    Launch action name.

  • active (boolean) –

    Whether the launch action is active.

  • order (integer) –

    Launch action order.

  • actionVersion (string) –

    Launch action version.

  • optional (boolean) –

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

  • parameters (dict) –

    Launch action parameters.

    • (string) –

      • (dict) –

        Launch action parameter.

        • value (string) –

          Value.

        • type (string) –

          Type.

  • description (string) –

    Launch action description.

  • category (string) –

    Launch action category.

Exceptions

• drs.Client.exceptions.ResourceNotFoundException

• drs.Client.exceptions.InternalServerException

• drs.Client.exceptions.ConflictException

• drs.Client.exceptions.ThrottlingException

• drs.Client.exceptions.ValidationException

• drs.Client.exceptions.UninitializedAccountException