RoboMaker / Client / list_deployment_jobs

list_deployment_jobs

RoboMaker.Client.list_deployment_jobs(**kwargs)

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

Warning

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

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 = client.list_deployment_jobs(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)

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

• nextToken (string) – If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

• maxResults (integer) – When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable.

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

    If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

Exceptions

• RoboMaker.Client.exceptions.ResourceNotFoundException

• RoboMaker.Client.exceptions.InvalidParameterException

• RoboMaker.Client.exceptions.InternalServerException

• RoboMaker.Client.exceptions.ThrottlingException