drs / Client / list_launch_actions

list_launch_actions#

drs.Client.list_launch_actions(**kwargs)#

Lists resource launch actions.

See also: AWS API Documentation

Request Syntax

response = client.list_launch_actions(
    filters={
        'actionIds': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string',
    resourceId='string'
)
Parameters:

  • filters (dict) –

    Filters to apply when listing resource launch actions.

    • actionIds (list) –

      Launch actions Ids.

      • (string) –

        Launch action Id.

  • maxResults (integer) – Maximum amount of items to return when listing resource launch actions.

  • nextToken (string) – Next token to use when listing resource launch actions.

  • resourceId (string) –

    [REQUIRED]

    Launch configuration template Id or Source Server Id

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            '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'
                }
            },
            'type': 'SSM_AUTOMATION'|'SSM_COMMAND'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      List of resource launch actions.

      • (dict) –

        Launch action.

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

        • type (string) –

          Launch action type.

    • nextToken (string) –

      Next token returned when listing resource launch actions.

Exceptions