mgn / Paginator / DescribeLaunchConfigurationTemplates

DescribeLaunchConfigurationTemplates

class mgn.Paginator.DescribeLaunchConfigurationTemplates

paginator = client.get_paginator('describe_launch_configuration_templates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from mgn.Client.describe_launch_configuration_templates().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• launchConfigurationTemplateIDs (list) –

  Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

  • (string) –

• 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': [
        {
            'launchConfigurationTemplateID': 'string',
            'arn': 'string',
            'postLaunchActions': {
                'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
                's3LogBucket': 'string',
                's3OutputKeyPrefix': 'string',
                'cloudWatchLogGroupName': 'string',
                'ssmDocuments': [
                    {
                        'actionName': 'string',
                        'ssmDocumentName': 'string',
                        'timeoutSeconds': 123,
                        'mustSucceedForCutover': True|False,
                        'parameters': {
                            'string': [
                                {
                                    'parameterType': 'STRING'|'SECURE_STRING',
                                    'parameterName': 'string'
                                },
                            ]
                        },
                        'externalParameters': {
                            'string': {
                                'dynamicPath': 'string'
                            }
                        }
                    },
                ]
            },
            'enableMapAutoTagging': True|False,
            'mapAutoTaggingMpeID': 'string',
            'tags': {
                'string': 'string'
            },
            'ec2LaunchTemplateID': 'string',
            'launchDisposition': 'STOPPED'|'STARTED',
            'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
            'copyPrivateIp': True|False,
            'associatePublicIpAddress': True|False,
            'copyTags': True|False,
            'licensing': {
                'osByol': True|False
            },
            'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
            'smallVolumeMaxSize': 123,
            'smallVolumeConf': {
                'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
                'iops': 123,
                'throughput': 123
            },
            'largeVolumeConf': {
                'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
                'iops': 123,
                'throughput': 123
            },
            'enableParametersEncryption': True|False,
            'parametersEncryptionKey': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    List of items returned by DescribeLaunchConfigurationTemplates.

    • (dict) –

      • launchConfigurationTemplateID (string) –

        ID of the Launch Configuration Template.

      • arn (string) –

        ARN of the Launch Configuration Template.

      • postLaunchActions (dict) –

        Post Launch Actions of the Launch Configuration Template.

        • deployment (string) –

          Deployment type in which AWS Systems Manager Documents will be executed.

        • s3LogBucket (string) –

          AWS Systems Manager Command’s logs S3 log bucket.

        • s3OutputKeyPrefix (string) –

          AWS Systems Manager Command’s logs S3 output key prefix.

        • cloudWatchLogGroupName (string) –

          AWS Systems Manager Command’s CloudWatch log group name.

        • ssmDocuments (list) –

          AWS Systems Manager Documents.

          • (dict) –

            AWS Systems Manager Document.

            • actionName (string) –

              User-friendly name for the AWS Systems Manager Document.

            • ssmDocumentName (string) –

              AWS Systems Manager Document name or full ARN.

            • timeoutSeconds (integer) –

              AWS Systems Manager Document timeout seconds.

            • mustSucceedForCutover (boolean) –

              If true, Cutover will not be enabled if the document has failed.

            • parameters (dict) –

              AWS Systems Manager Document parameters.

              • (string) –

                • (list) –

                  • (dict) –

                    AWS Systems Manager Parameter Store parameter.

                    • parameterType (string) –

                      AWS Systems Manager Parameter Store parameter type.

                    • parameterName (string) –

                      AWS Systems Manager Parameter Store parameter name.

            • externalParameters (dict) –

              AWS Systems Manager Document external parameters.

              • (string) –

                • (dict) –

                  AWS Systems Manager Document external parameter.

                  Note

                  This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. 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'}
                  

                  • dynamicPath (string) –

                    AWS Systems Manager Document external parameters dynamic path.

      • enableMapAutoTagging (boolean) –

        Enable map auto tagging.

      • mapAutoTaggingMpeID (string) –

        Launch configuration template map auto tagging MPE ID.

      • tags (dict) –

        Tags of the Launch Configuration Template.

        • (string) –

          • (string) –

      • ec2LaunchTemplateID (string) –

        EC2 launch template ID.

      • launchDisposition (string) –

        Launch disposition.

      • targetInstanceTypeRightSizingMethod (string) –

        Target instance type right-sizing method.

      • copyPrivateIp (boolean) –

        Copy private Ip.

      • associatePublicIpAddress (boolean) –

        Associate public Ip address.

      • copyTags (boolean) –

        Copy tags.

      • licensing (dict) –

        Configure Licensing.

        • osByol (boolean) –

          Configure BYOL OS licensing.

      • bootMode (string) –

        Launch configuration template boot mode.

      • smallVolumeMaxSize (integer) –

        Small volume maximum size.

      • smallVolumeConf (dict) –

        Small volume config.

        • volumeType (string) –

          Launch template disk volume type configuration.

        • iops (integer) –

          Launch template disk iops configuration.

        • throughput (integer) –

          Launch template disk throughput configuration.

      • largeVolumeConf (dict) –

        Large volume config.

        • volumeType (string) –

          Launch template disk volume type configuration.

        • iops (integer) –

          Launch template disk iops configuration.

        • throughput (integer) –

          Launch template disk throughput configuration.

      • enableParametersEncryption (boolean) –

        Enable parameters encryption.

      • parametersEncryptionKey (string) –

        Parameters encryption key.

  • NextToken (string) –

    A token to resume pagination.