drs / Paginator / ListLaunchActions

ListLaunchActions

class drs.Paginator.ListLaunchActions

paginator = client.get_paginator('list_launch_actions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from drs.Client.list_launch_actions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'actionIds': [
            'string',
        ]
    },
    resourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (dict) –

  Filters to apply when listing resource launch actions.

  • actionIds (list) –

    Launch actions Ids.

    • (string) –

      Launch action Id.

• resourceId (string) –

  [REQUIRED]

  Launch configuration template Id or Source Server Id

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.