AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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. Only used for custom actions.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodePipeline.AmazonCodePipelineRequest
      Amazon.CodePipeline.Model.AcknowledgeJobRequest

Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public class AcknowledgeJobRequest : AmazonCodePipelineRequest
         IAmazonWebServiceRequest

The AcknowledgeJobRequest type exposes the following members

Constructors

NameDescription
Public Method AcknowledgeJobRequest()

Properties

NameTypeDescription
Public Property JobId System.String

Gets and sets the property JobId.

The unique system-generated ID of the job for which you want to confirm receipt.

Public Property Nonce System.String

Gets and sets the property Nonce.

A system-generated random number that AWS 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 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 Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms