Container for the parameters to the AcknowledgeJob operation. Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CodePipeline.AmazonCodePipelineRequest
Amazon.CodePipeline.Model.AcknowledgeJobRequest
Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z
Syntax
public class AcknowledgeJobRequest : AmazonCodePipelineRequest IAmazonWebServiceRequest
The AcknowledgeJobRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AcknowledgeJobRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
JobId | System.String |
Gets and sets the property JobId. The unique system-generated ID of the job for which you want to confirm receipt. |
|
|
Nonce | System.String |
Gets and sets the property Nonce. A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job. |
Examples
This example returns information about a specified job, including the status of that job if it exists. This is only used for job workers and custom actions in AWS CodePipeline. To determine the value of nonce and the job ID, use PollForJobs.
Acknowledge a job for a custom action
var client = new AmazonCodePipelineClient();
var response = client.AcknowledgeJob(new AcknowledgeJobRequest
{
JobId = "11111111-abcd-1111-abcd-111111abcdef", // Use the PollforJobs API to determine the ID of the job.
Nonce = "3" // Use the PollforJobs API to determine the nonce for the job.
});
string status = response.Status; // Valid values include Created, Queued, Dispatched, InProgress, TimedOut, Suceeded, and Failed. Completed jobs are removed from the system after a short period of time.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5