AWS Clean Rooms Service

2025/09/04 - AWS Clean Rooms Service - 3 updated api methods

Changes  Add support for configurable compute sizes for PySpark jobs.

GetProtectedJob (updated) Link ¶
Changes (response) 
{'protectedJob': {'computeConfiguration': {'worker': {'number': 'integer',
                                                      'type': 'CR.1X | '
                                                              'CR.4X'}}}}

Returns job processing metadata.

See also: AWS API Documentation

Request Syntax

client.get_protected_job(
    membershipIdentifier='string',
    protectedJobIdentifier='string'
)
type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The identifier for a membership in a protected job instance.

type protectedJobIdentifier:

string

param protectedJobIdentifier:

[REQUIRED]

The identifier for the protected job instance.

rtype:

dict

returns:

Response Syntax

{
    'protectedJob': {
        'id': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'createTime': datetime(2015, 1, 1),
        'jobParameters': {
            'analysisTemplateArn': 'string'
        },
        'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
        'resultConfiguration': {
            'outputConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string'
                },
                'member': {
                    'accountId': 'string'
                }
            }
        },
        'statistics': {
            'totalDurationInMillis': 123,
            'billedResourceUtilization': {
                'units': 123.0
            }
        },
        'result': {
            'output': {
                's3': {
                    'location': 'string'
                },
                'memberList': [
                    {
                        'accountId': 'string'
                    },
                ]
            }
        },
        'error': {
            'message': 'string',
            'code': 'string'
        },
        'computeConfiguration': {
            'worker': {
                'type': 'CR.1X'|'CR.4X',
                'number': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • protectedJob (dict) --

      The protected job metadata.

      • id (string) --

        The identifier for a protected job instance.

      • membershipId (string) --

        he identifier for the membership.

      • membershipArn (string) --

        The ARN of the membership.

      • createTime (datetime) --

        The creation time of the protected job.

      • jobParameters (dict) --

        The job parameters for the protected job.

        • analysisTemplateArn (string) --

          The ARN of the analysis template.

      • status (string) --

        The status of the protected job.

      • resultConfiguration (dict) --

        Contains any details needed to write the job results.

        • outputConfiguration (dict) --

          The output configuration.

          • s3 (dict) --

            If present, the output for a protected job with an S3 output type.

            • bucket (string) --

              The S3 bucket for job output.

            • keyPrefix (string) --

              The S3 prefix to unload the protected job results.

          • member (dict) --

            The member output configuration for a protected job.

            • accountId (string) --

              The account ID.

      • statistics (dict) --

        The statistics of the protected job.

        • totalDurationInMillis (integer) --

          The duration of the protected job, from creation until job completion, in milliseconds.

        • billedResourceUtilization (dict) --

          The billed resource utilization for the protected job.

          • units (float) --

            The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.

      • result (dict) --

        The result of the protected job.

        • output (dict) --

          The output of the protected job.

          • s3 (dict) --

            If present, the output for a protected job with an S3 output type.

            • location (string) --

              The S3 location for the protected job output.

          • memberList (list) --

            The list of member Amazon Web Services account(s) that received the results of the job.

            • (dict) --

              Details about the member who received the job result.

              • accountId (string) --

                The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.

      • error (dict) --

        The error from the protected job.

        • message (string) --

          The message for the protected job error.

        • code (string) --

          The error code for the protected job.

      • computeConfiguration (dict) --

        The compute configuration for the protected job.

        • worker (dict) --

          The worker configuration for the compute environment.

          • type (string) --

            The worker compute configuration type.

          • number (integer) --

            The number of workers for a PySpark job.

StartProtectedJob (updated) Link ¶
Changes (request, response)
Request 
{'computeConfiguration': {'worker': {'number': 'integer',
                                     'type': 'CR.1X | CR.4X'}}}
Response 
{'protectedJob': {'computeConfiguration': {'worker': {'number': 'integer',
                                                      'type': 'CR.1X | '
                                                              'CR.4X'}}}}

Creates a protected job that is started by Clean Rooms.

See also: AWS API Documentation

Request Syntax

client.start_protected_job(
    type='PYSPARK',
    membershipIdentifier='string',
    jobParameters={
        'analysisTemplateArn': 'string'
    },
    resultConfiguration={
        'outputConfiguration': {
            'member': {
                'accountId': 'string'
            }
        }
    },
    computeConfiguration={
        'worker': {
            'type': 'CR.1X'|'CR.4X',
            'number': 123
        }
    }
)
type type:

string

param type:

[REQUIRED]

The type of protected job to start.

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

A unique identifier for the membership to run this job against. Currently accepts a membership ID.

type jobParameters:

dict

param jobParameters:

[REQUIRED]

The job parameters.

  • analysisTemplateArn (string) --

    The ARN of the analysis template.

type resultConfiguration:

dict

param resultConfiguration:

The details needed to write the job results.

  • outputConfiguration (dict) -- [REQUIRED]

    The output configuration for a protected job result.

    • member (dict) --

      The member of the protected job output configuration input.

      • accountId (string) -- [REQUIRED]

        The account ID.

type computeConfiguration:

dict

param computeConfiguration:

The compute configuration for the protected job.

  • worker (dict) --

    The worker configuration for the compute environment.

    • type (string) -- [REQUIRED]

      The worker compute configuration type.

    • number (integer) -- [REQUIRED]

      The number of workers for a PySpark job.

rtype:

dict

returns:

Response Syntax

{
    'protectedJob': {
        'id': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'createTime': datetime(2015, 1, 1),
        'jobParameters': {
            'analysisTemplateArn': 'string'
        },
        'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
        'resultConfiguration': {
            'outputConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string'
                },
                'member': {
                    'accountId': 'string'
                }
            }
        },
        'statistics': {
            'totalDurationInMillis': 123,
            'billedResourceUtilization': {
                'units': 123.0
            }
        },
        'result': {
            'output': {
                's3': {
                    'location': 'string'
                },
                'memberList': [
                    {
                        'accountId': 'string'
                    },
                ]
            }
        },
        'error': {
            'message': 'string',
            'code': 'string'
        },
        'computeConfiguration': {
            'worker': {
                'type': 'CR.1X'|'CR.4X',
                'number': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • protectedJob (dict) --

      The protected job.

      • id (string) --

        The identifier for a protected job instance.

      • membershipId (string) --

        he identifier for the membership.

      • membershipArn (string) --

        The ARN of the membership.

      • createTime (datetime) --

        The creation time of the protected job.

      • jobParameters (dict) --

        The job parameters for the protected job.

        • analysisTemplateArn (string) --

          The ARN of the analysis template.

      • status (string) --

        The status of the protected job.

      • resultConfiguration (dict) --

        Contains any details needed to write the job results.

        • outputConfiguration (dict) --

          The output configuration.

          • s3 (dict) --

            If present, the output for a protected job with an S3 output type.

            • bucket (string) --

              The S3 bucket for job output.

            • keyPrefix (string) --

              The S3 prefix to unload the protected job results.

          • member (dict) --

            The member output configuration for a protected job.

            • accountId (string) --

              The account ID.

      • statistics (dict) --

        The statistics of the protected job.

        • totalDurationInMillis (integer) --

          The duration of the protected job, from creation until job completion, in milliseconds.

        • billedResourceUtilization (dict) --

          The billed resource utilization for the protected job.

          • units (float) --

            The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.

      • result (dict) --

        The result of the protected job.

        • output (dict) --

          The output of the protected job.

          • s3 (dict) --

            If present, the output for a protected job with an S3 output type.

            • location (string) --

              The S3 location for the protected job output.

          • memberList (list) --

            The list of member Amazon Web Services account(s) that received the results of the job.

            • (dict) --

              Details about the member who received the job result.

              • accountId (string) --

                The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.

      • error (dict) --

        The error from the protected job.

        • message (string) --

          The message for the protected job error.

        • code (string) --

          The error code for the protected job.

      • computeConfiguration (dict) --

        The compute configuration for the protected job.

        • worker (dict) --

          The worker configuration for the compute environment.

          • type (string) --

            The worker compute configuration type.

          • number (integer) --

            The number of workers for a PySpark job.

UpdateProtectedJob (updated) Link ¶
Changes (response) 
{'protectedJob': {'computeConfiguration': {'worker': {'number': 'integer',
                                                      'type': 'CR.1X | '
                                                              'CR.4X'}}}}

Updates the processing of a currently running job.

See also: AWS API Documentation

Request Syntax

client.update_protected_job(
    membershipIdentifier='string',
    protectedJobIdentifier='string',
    targetStatus='CANCELLED'
)
type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The identifier for a member of a protected job instance.

type protectedJobIdentifier:

string

param protectedJobIdentifier:

[REQUIRED]

The identifier of the protected job to update.

type targetStatus:

string

param targetStatus:

[REQUIRED]

The target status of a protected job. Used to update the execution status of a currently running job.

rtype:

dict

returns:

Response Syntax

{
    'protectedJob': {
        'id': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'createTime': datetime(2015, 1, 1),
        'jobParameters': {
            'analysisTemplateArn': 'string'
        },
        'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
        'resultConfiguration': {
            'outputConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string'
                },
                'member': {
                    'accountId': 'string'
                }
            }
        },
        'statistics': {
            'totalDurationInMillis': 123,
            'billedResourceUtilization': {
                'units': 123.0
            }
        },
        'result': {
            'output': {
                's3': {
                    'location': 'string'
                },
                'memberList': [
                    {
                        'accountId': 'string'
                    },
                ]
            }
        },
        'error': {
            'message': 'string',
            'code': 'string'
        },
        'computeConfiguration': {
            'worker': {
                'type': 'CR.1X'|'CR.4X',
                'number': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • protectedJob (dict) --

      The protected job output.

      • id (string) --

        The identifier for a protected job instance.

      • membershipId (string) --

        he identifier for the membership.

      • membershipArn (string) --

        The ARN of the membership.

      • createTime (datetime) --

        The creation time of the protected job.

      • jobParameters (dict) --

        The job parameters for the protected job.

        • analysisTemplateArn (string) --

          The ARN of the analysis template.

      • status (string) --

        The status of the protected job.

      • resultConfiguration (dict) --

        Contains any details needed to write the job results.

        • outputConfiguration (dict) --

          The output configuration.

          • s3 (dict) --

            If present, the output for a protected job with an S3 output type.

            • bucket (string) --

              The S3 bucket for job output.

            • keyPrefix (string) --

              The S3 prefix to unload the protected job results.

          • member (dict) --

            The member output configuration for a protected job.

            • accountId (string) --

              The account ID.

      • statistics (dict) --

        The statistics of the protected job.

        • totalDurationInMillis (integer) --

          The duration of the protected job, from creation until job completion, in milliseconds.

        • billedResourceUtilization (dict) --

          The billed resource utilization for the protected job.

          • units (float) --

            The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.

      • result (dict) --

        The result of the protected job.

        • output (dict) --

          The output of the protected job.

          • s3 (dict) --

            If present, the output for a protected job with an S3 output type.

            • location (string) --

              The S3 location for the protected job output.

          • memberList (list) --

            The list of member Amazon Web Services account(s) that received the results of the job.

            • (dict) --

              Details about the member who received the job result.

              • accountId (string) --

                The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.

      • error (dict) --

        The error from the protected job.

        • message (string) --

          The message for the protected job error.

        • code (string) --

          The error code for the protected job.

      • computeConfiguration (dict) --

        The compute configuration for the protected job.

        • worker (dict) --

          The worker configuration for the compute environment.

          • type (string) --

            The worker compute configuration type.

          • number (integer) --

            The number of workers for a PySpark job.