DeadlineCloud / Client / batch_get_job_entity

batch_get_job_entity#

DeadlineCloud.Client.batch_get_job_entity(**kwargs)#

Get batched job details for a worker.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_job_entity(
    farmId='string',
    fleetId='string',
    identifiers=[
        {
            'environmentDetails': {
                'environmentId': 'string',
                'jobId': 'string'
            },
            'jobAttachmentDetails': {
                'jobId': 'string'
            },
            'jobDetails': {
                'jobId': 'string'
            },
            'stepDetails': {
                'jobId': 'string',
                'stepId': 'string'
            }
        },
    ],
    workerId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID of the worker that’s fetching job details. The worker must have an assignment on a job to fetch job details.

  • fleetId (string) –

    [REQUIRED]

    The fleet ID of the worker that’s fetching job details. The worker must have an assignment on a job to fetch job details.

  • identifiers (list) –

    [REQUIRED]

    The job identifiers to include within the job entity batch details.

    • (dict) –

      The details of a job entity identifier.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: environmentDetails, jobAttachmentDetails, jobDetails, stepDetails.

      • environmentDetails (dict) –

        The environment details.

        • environmentId (string) – [REQUIRED]

          The environment ID.

        • jobId (string) – [REQUIRED]

          The job ID.

      • jobAttachmentDetails (dict) –

        The job attachment details.

        • jobId (string) – [REQUIRED]

          The job ID.

      • jobDetails (dict) –

        The job details.

        • jobId (string) – [REQUIRED]

          The job ID.

      • stepDetails (dict) –

        The step details.

        • jobId (string) – [REQUIRED]

          The job ID.

        • stepId (string) – [REQUIRED]

          The step ID.

  • workerId (string) –

    [REQUIRED]

    The worker ID of the worker containing the job details to get.

Return type:

dict

Returns:

Response Syntax

{
    'entities': [
        {
            'environmentDetails': {
                'environmentId': 'string',
                'jobId': 'string',
                'schemaVersion': 'string',
                'template': {...}|[...]|123|123.4|'string'|True|None
            },
            'jobAttachmentDetails': {
                'attachments': {
                    'fileSystem': 'COPIED'|'VIRTUAL',
                    'manifests': [
                        {
                            'fileSystemLocationName': 'string',
                            'inputManifestHash': 'string',
                            'inputManifestPath': 'string',
                            'outputRelativeDirectories': [
                                'string',
                            ],
                            'rootPath': 'string',
                            'rootPathFormat': 'windows'|'posix'
                        },
                    ]
                },
                'jobId': 'string'
            },
            'jobDetails': {
                'jobAttachmentSettings': {
                    'rootPrefix': 'string',
                    's3BucketName': 'string'
                },
                'jobId': 'string',
                'jobRunAsUser': {
                    'posix': {
                        'group': 'string',
                        'user': 'string'
                    },
                    'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER',
                    'windows': {
                        'passwordArn': 'string',
                        'user': 'string'
                    }
                },
                'logGroupName': 'string',
                'parameters': {
                    'string': {
                        'float': 'string',
                        'int': 'string',
                        'path': 'string',
                        'string': 'string'
                    }
                },
                'pathMappingRules': [
                    {
                        'destinationPath': 'string',
                        'sourcePath': 'string',
                        'sourcePathFormat': 'windows'|'posix'
                    },
                ],
                'queueRoleArn': 'string',
                'schemaVersion': 'string'
            },
            'stepDetails': {
                'dependencies': [
                    'string',
                ],
                'jobId': 'string',
                'schemaVersion': 'string',
                'stepId': 'string',
                'template': {...}|[...]|123|123.4|'string'|True|None
            }
        },
    ],
    'errors': [
        {
            'environmentDetails': {
                'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
                'environmentId': 'string',
                'jobId': 'string',
                'message': 'string'
            },
            'jobAttachmentDetails': {
                'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
                'jobId': 'string',
                'message': 'string'
            },
            'jobDetails': {
                'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
                'jobId': 'string',
                'message': 'string'
            },
            'stepDetails': {
                'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
                'jobId': 'string',
                'message': 'string',
                'stepId': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • entities (list) –

      A list of the job entities, or details, in the batch.

      • (dict) –

        The details of a job entity.

        Note

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

        • environmentDetails (dict) –

          The environment details for the job entity.

          • environmentId (string) –

            The environment ID.

          • jobId (string) –

            The job ID.

          • schemaVersion (string) –

            The schema version in the environment.

          • template (document) –

            The template used for the environment.

        • jobAttachmentDetails (dict) –

          The job attachment details.

          • attachments (dict) –

            The job attachments.

            • fileSystem (string) –

              The file system.

            • manifests (list) –

              A list of manifests which describe job attachment configurations.

              • (dict) –

                The details of the manifest that links a job’s source information.

                • fileSystemLocationName (string) –

                  The file system location name.

                • inputManifestHash (string) –

                  The has value of the file.

                • inputManifestPath (string) –

                  The file path.

                • outputRelativeDirectories (list) –

                  The file path relative to the directory.

                  • (string) –

                • rootPath (string) –

                  The file’s root path.

                • rootPathFormat (string) –

                  The format of the root path.

          • jobId (string) –

            The job ID.

        • jobDetails (dict) –

          The job details.

          • jobAttachmentSettings (dict) –

            The job attachment settings.

            • rootPrefix (string) –

              The root prefix.

            • s3BucketName (string) –

              The Amazon S3 bucket name.

          • jobId (string) –

            The job ID.

          • jobRunAsUser (dict) –

            The user name and group that the job uses when run.

            • posix (dict) –

              The user and group that the jobs in the queue run as.

              • group (string) –

                The name of the POSIX user’s group.

              • user (string) –

                The name of the POSIX user.

            • runAs (string) –

              Specifies whether the job should run using the queue’s system user or if the job should run using the worker agent system user.

            • windows (dict) –

              Identifies a Microsoft Windows user.

              • passwordArn (string) –

                The password ARN for the Windows user.

              • user (string) –

                The user.

          • logGroupName (string) –

            The log group name.

          • parameters (dict) –

            The parameters.

            • (string) –

              • (dict) –

                The details of job parameters.

                Note

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

                • float (string) –

                  A double precision IEEE-754 floating point number represented as a string.

                • int (string) –

                  A signed integer represented as a string.

                • path (string) –

                  A file system path represented as a string.

                • string (string) –

                  A UTF-8 string.

          • pathMappingRules (list) –

            The path mapping rules.

            • (dict) –

              The details of a source and destination path.

              • destinationPath (string) –

                The destination path.

              • sourcePath (string) –

                The source path.

              • sourcePathFormat (string) –

                The source path format.

          • queueRoleArn (string) –

            The queue role ARN.

          • schemaVersion (string) –

            The schema version.

        • stepDetails (dict) –

          The step details.

          • dependencies (list) –

            The dependencies for a step.

            • (string) –

          • jobId (string) –

            The job ID.

          • schemaVersion (string) –

            The schema version for a step template.

          • stepId (string) –

            The step ID.

          • template (document) –

            The template for a step.

    • errors (list) –

      A list of errors from the job error logs for the batch.

      • (dict) –

        The error for the job entity.

        Note

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

        • environmentDetails (dict) –

          The environment details for the failed job entity.

          • code (string) –

            The error code.

          • environmentId (string) –

            The environment ID.

          • jobId (string) –

            The job ID.

          • message (string) –

            The error message detailing the error’s cause.

        • jobAttachmentDetails (dict) –

          The job attachment details for the failed job entity.

          • code (string) –

            The error code.

          • jobId (string) –

            The job ID.

          • message (string) –

            The error message detailing the error’s cause.

        • jobDetails (dict) –

          The job details for the failed job entity.

          • code (string) –

            The error code.

          • jobId (string) –

            The job ID.

          • message (string) –

            The error message detailing the error’s cause.

        • stepDetails (dict) –

          The step details for the failed job entity.

          • code (string) –

            The error code.

          • jobId (string) –

            The job ID.

          • message (string) –

            The error message detailing the error’s cause.

          • stepId (string) –

            The step ID.

Exceptions