StartProtectedJobCommand

Suggest an Edit

Creates a protected job that is started by Clean Rooms.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CleanRoomsClient, StartProtectedJobCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
// const { CleanRoomsClient, StartProtectedJobCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
const client = new CleanRoomsClient(config);
const input = { // StartProtectedJobInput
  type: "PYSPARK", // required
  membershipIdentifier: "STRING_VALUE", // required
  jobParameters: { // ProtectedJobParameters
    analysisTemplateArn: "STRING_VALUE",
  },
  resultConfiguration: { // ProtectedJobResultConfigurationInput
    outputConfiguration: { // ProtectedJobOutputConfigurationInput Union: only one key present
      member: { // ProtectedJobMemberOutputConfigurationInput
        accountId: "STRING_VALUE", // required
      },
    },
  },
};
const command = new StartProtectedJobCommand(input);
const response = await client.send(command);
// { // StartProtectedJobOutput
//   protectedJob: { // ProtectedJob
//     id: "STRING_VALUE", // required
//     membershipId: "STRING_VALUE", // required
//     membershipArn: "STRING_VALUE", // required
//     createTime: new Date("TIMESTAMP"), // required
//     jobParameters: { // ProtectedJobParameters
//       analysisTemplateArn: "STRING_VALUE",
//     },
//     status: "SUBMITTED" || "STARTED" || "CANCELLED" || "CANCELLING" || "FAILED" || "SUCCESS", // required
//     resultConfiguration: { // ProtectedJobResultConfigurationOutput
//       outputConfiguration: { // ProtectedJobOutputConfigurationOutput Union: only one key present
//         s3: { // ProtectedJobS3OutputConfigurationOutput
//           bucket: "STRING_VALUE", // required
//           keyPrefix: "STRING_VALUE",
//         },
//         member: { // ProtectedJobMemberOutputConfigurationOutput
//           accountId: "STRING_VALUE", // required
//         },
//       },
//     },
//     statistics: { // ProtectedJobStatistics
//       totalDurationInMillis: Number("long"),
//       billedResourceUtilization: { // BilledJobResourceUtilization
//         units: Number("double"), // required
//       },
//     },
//     result: { // ProtectedJobResult
//       output: { // ProtectedJobOutput Union: only one key present
//         s3: { // ProtectedJobS3Output
//           location: "STRING_VALUE", // required
//         },
//         memberList: [ // ProtectedJobMemberOutputList
//           { // ProtectedJobSingleMemberOutput
//             accountId: "STRING_VALUE", // required
//           },
//         ],
//       },
//     },
//     error: { // ProtectedJobError
//       message: "STRING_VALUE", // required
//       code: "STRING_VALUE", // required
//     },
//   },
// };

StartProtectedJobCommand Input

See StartProtectedJobCommandInput for more details

Parameter
Type
Description
jobParameters
Required
ProtectedJobParameters | undefined

The job parameters.

membershipIdentifier
Required
string | undefined

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

type
Required
ProtectedJobType | undefined

The type of protected job to start.

resultConfiguration
ProtectedJobResultConfigurationInput | undefined

The details needed to write the job results.

StartProtectedJobCommand Output

See StartProtectedJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
protectedJob
Required
ProtectedJob | undefined

The protected job.

Throws

Name
Fault
Details
AccessDeniedException
client

Caller does not have sufficient access to perform this action.

InternalServerException
server

Unexpected error during processing of request.

ResourceNotFoundException
client

Request references a resource which does not exist.

ServiceQuotaExceededException
client

Request denied because service quota has been exceeded.

ThrottlingException
client

Request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the specified constraints.

CleanRoomsServiceException
Base exception class for all service exceptions from CleanRooms service.