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.

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

Note:

For PCL this operation is only available in asynchronous form. Please refer to AcknowledgeJobAsync.

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

Syntax

C#
public abstract AcknowledgeJobResponse AcknowledgeJob(
         AcknowledgeJobRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.AcknowledgeJobRequest

Container for the necessary parameters to execute the AcknowledgeJob service method.

Return Value
The response from the AcknowledgeJob service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
InvalidNonceException The specified nonce was specified in an invalid format.
JobNotFoundException The specified job was specified in an invalid format or cannot be found.
ValidationException The validation was specified in an invalid format.

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 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

See Also