RoboMaker / Paginator / ListDeploymentJobs

ListDeploymentJobs

class RoboMaker.Paginator.ListDeploymentJobs

paginator = client.get_paginator('list_deployment_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_deployment_jobs().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filters (list) –

  Optional filters to limit results.

  The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

  • (dict) –

    Information about a filter.

    • name (string) –

      The name of the filter.

    • values (list) –

      A list of values.

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

{
    'deploymentJobs': [
        {
            'arn': 'string',
            'fleet': 'string',
            'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
            'deploymentApplicationConfigs': [
                {
                    'application': 'string',
                    'applicationVersion': 'string',
                    'launchConfig': {
                        'packageName': 'string',
                        'preLaunchFile': 'string',
                        'launchFile': 'string',
                        'postLaunchFile': 'string',
                        'environmentVariables': {
                            'string': 'string'
                        }
                    }
                },
            ],
            'deploymentConfig': {
                'concurrentDeploymentPercentage': 123,
                'failureThresholdPercentage': 123,
                'robotDeploymentTimeoutInSeconds': 123,
                'downloadConditionFile': {
                    'bucket': 'string',
                    'key': 'string',
                    'etag': 'string'
                }
            },
            'failureReason': 'string',
            'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • deploymentJobs (list) –

    A list of deployment jobs that meet the criteria of the request.

    • (dict) –

      Information about a deployment job.

      • arn (string) –

        The Amazon Resource Name (ARN) of the deployment job.

      • fleet (string) –

        The Amazon Resource Name (ARN) of the fleet.

      • status (string) –

        The status of the deployment job.

      • deploymentApplicationConfigs (list) –

        The deployment application configuration.

        • (dict) –

          Information about a deployment application configuration.

          • application (string) –

            The Amazon Resource Name (ARN) of the robot application.

          • applicationVersion (string) –

            The version of the application.

          • launchConfig (dict) –

            The launch configuration.

            • packageName (string) –

              The package name.

            • preLaunchFile (string) –

              The deployment pre-launch file. This file will be executed prior to the launch file.

            • launchFile (string) –

              The launch file name.

            • postLaunchFile (string) –

              The deployment post-launch file. This file will be executed after the launch file.

            • environmentVariables (dict) –

              An array of key/value pairs specifying environment variables for the robot application

              • (string) –

                • (string) –

      • deploymentConfig (dict) –

        The deployment configuration.

        • concurrentDeploymentPercentage (integer) –

          The percentage of robots receiving the deployment at the same time.

        • failureThresholdPercentage (integer) –

          The percentage of deployments that need to fail before stopping deployment.

        • robotDeploymentTimeoutInSeconds (integer) –

          The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.

        • downloadConditionFile (dict) –

          The download condition file.

          • bucket (string) –

            The bucket containing the object.

          • key (string) –

            The key of the object.

          • etag (string) –

            The etag of the object.

      • failureReason (string) –

        A short description of the reason why the deployment job failed.

      • failureCode (string) –

        The deployment job failure code.

      • createdAt (datetime) –

        The time, in milliseconds since the epoch, when the deployment job was created.

  • NextToken (string) –

    A token to resume pagination.