Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.simpleworkflow;
  
  import java.net.*;
  import java.util.*;
  
  
  import com.amazonaws.*;
  
Client for accessing AmazonSimpleWorkflow. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Simple Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

  
  public class AmazonSimpleWorkflowClient extends AmazonWebServiceClient implements AmazonSimpleWorkflow {

    
Provider for AWS credentials.
  
  
      private static final Log log = LogFactory.getLog(AmazonSimpleWorkflow.class);

    
List of exception unmarshallers for all AmazonSimpleWorkflow exceptions.
  
      protected List<JsonErrorUnmarshallerjsonErrorUnmarshallers;

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow. A credentials provider chain will be used that searches for credentials in this order:
  • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
  • Java System Properties - aws.accessKeyId and aws.secretKey
  • Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

  
      public AmazonSimpleWorkflowClient() {
          this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
      }

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow. A credentials provider chain will be used that searches for credentials in this order:
  • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
  • Java System Properties - aws.accessKeyId and aws.secretKey
  • Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
clientConfiguration The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).
See also:
com.amazonaws.auth.DefaultAWSCredentialsProviderChain
 
     public AmazonSimpleWorkflowClient(ClientConfiguration clientConfiguration) {
         this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
     }

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
 
     public AmazonSimpleWorkflowClient(AWSCredentials awsCredentials) {
         this(awsCredentialsnew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).
 
     public AmazonSimpleWorkflowClient(AWSCredentials awsCredentialsClientConfiguration clientConfiguration) {
         super(adjustClientConfiguration(clientConfiguration));
         
         this. = new StaticCredentialsProvider(awsCredentials);
         
         init();
     }

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
 
     public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider) {
         this(awsCredentialsProvidernew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).
 
     public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProviderClientConfiguration clientConfiguration) {
         this(awsCredentialsProviderclientConfigurationnull);
     }

    
Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).
requestMetricCollector optional request metric collector
 
     public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider,
             ClientConfiguration clientConfiguration,
             RequestMetricCollector requestMetricCollector) {
         super(adjustClientConfiguration(clientConfiguration), requestMetricCollector);
         
         this. = awsCredentialsProvider;
         
         init();
     }
 
     private void init() {
         
         
         // calling this.setEndPoint(...) will also modify the signer accordingly
         this.setEndpoint("swf.us-east-1.amazonaws.com");
         
         HandlerChainFactory chainFactory = new HandlerChainFactory();
         .addAll(chainFactory.newRequestHandlerChain(
                 "/com/amazonaws/services/simpleworkflow/request.handlers"));
         .addAll(chainFactory.newRequestHandler2Chain(
                 "/com/amazonaws/services/simpleworkflow/request.handler2s"));
     }
 
         ClientConfiguration config = orig;
         
         config = new ClientConfiguration(orig);
         if (config.getMaxConnections() == .) {
             .debug("Overriding default max connection value to: " + 1000);
             config.setMaxConnections(1000);
         }
         if (config.getSocketTimeout() == .) {
             .debug("Overriding default socket timeout value to: " + 90000);
             config.setSocketTimeout(90000);
         }
         return config;
     }

    

Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • workflowType.name : String constraint. The key is swf:workflowType.name .
    • workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
deprecateWorkflowTypeRequest Container for the necessary parameters to execute the DeprecateWorkflowType service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.TypeDeprecatedException
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public void deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) {
         ExecutionContext executionContext = createExecutionContext(deprecateWorkflowTypeRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DeprecateWorkflowTypeRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DeprecateWorkflowTypeRequestMarshaller().marshall(super.beforeMarshalling(deprecateWorkflowTypeRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
deprecateDomainRequest Container for the necessary parameters to execute the DeprecateDomain service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.DomainDeprecatedException
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public void deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) {
         ExecutionContext executionContext = createExecutionContext(deprecateDomainRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DeprecateDomainRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DeprecateDomainRequestMarshaller().marshall(super.beforeMarshalling(deprecateDomainRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

IMPORTANT:If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • defaultTaskList.name : String constraint. The key is swf:defaultTaskList.name .
    • name : String constraint. The key is swf:name .
    • version : String constraint. The key is swf:version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
registerWorkflowTypeRequest Container for the necessary parameters to execute the RegisterWorkflowType service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.services.simpleworkflow.model.TypeAlreadyExistsException
com.amazonaws.services.simpleworkflow.model.LimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public void registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) {
         ExecutionContext executionContext = createExecutionContext(registerWorkflowTypeRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<RegisterWorkflowTypeRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new RegisterWorkflowTypeRequestMarshaller().marshall(super.beforeMarshalling(registerWorkflowTypeRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
listWorkflowTypesRequest Container for the necessary parameters to execute the ListWorkflowTypes service method on AmazonSimpleWorkflow.
Returns:
The response from the ListWorkflowTypes service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public WorkflowTypeInfos listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) {
         ExecutionContext executionContext = createExecutionContext(listWorkflowTypesRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<ListWorkflowTypesRequestrequest = null;
         Response<WorkflowTypeInfosresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new ListWorkflowTypesRequestMarshaller().marshall(super.beforeMarshalling(listWorkflowTypesRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<WorkflowTypeInfosJsonUnmarshallerContextunmarshaller =
                 new WorkflowTypeInfosJsonUnmarshaller();
             JsonResponseHandler<WorkflowTypeInfosresponseHandler =
                 new JsonResponseHandler<WorkflowTypeInfos>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagList.member.0 : The key is swf:tagList.member.0 .
    • tagList.member.1 : The key is swf:tagList.member.1 .
    • tagList.member.2 : The key is swf:tagList.member.2 .
    • tagList.member.3 : The key is swf:tagList.member.3 .
    • tagList.member.4 : The key is swf:tagList.member.4 .
    • taskList : String constraint. The key is swf:taskList.name .
    • workflowType.name : String constraint. The key is swf:workflowType.name .
    • workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
startWorkflowExecutionRequest Container for the necessary parameters to execute the StartWorkflowExecution service method on AmazonSimpleWorkflow.
Returns:
The response from the StartWorkflowExecution service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.TypeDeprecatedException
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.DefaultUndefinedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.services.simpleworkflow.model.WorkflowExecutionAlreadyStartedException
com.amazonaws.services.simpleworkflow.model.LimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public Run startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest) {
         ExecutionContext executionContext = createExecutionContext(startWorkflowExecutionRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<StartWorkflowExecutionRequestrequest = null;
         Response<Runresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new StartWorkflowExecutionRequestMarshaller().marshall(super.beforeMarshalling(startWorkflowExecutionRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<RunJsonUnmarshallerContextunmarshaller =
                 new RunJsonUnmarshaller();
             JsonResponseHandler<RunresponseHandler =
                 new JsonResponseHandler<Run>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

NOTE: If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

NOTE: If the specified workflow execution is not open, this method fails with UnknownResource.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
signalWorkflowExecutionRequest Container for the necessary parameters to execute the SignalWorkflowExecution service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public void signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) {
         ExecutionContext executionContext = createExecutionContext(signalWorkflowExecutionRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<SignalWorkflowExecutionRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new SignalWorkflowExecutionRequestMarshaller().marshall(super.beforeMarshalling(signalWorkflowExecutionRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/* , where AccountID is the account ID, with no dashes.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
listDomainsRequest Container for the necessary parameters to execute the ListDomains service method on AmazonSimpleWorkflow.
Returns:
The response from the ListDomains service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public DomainInfos listDomains(ListDomainsRequest listDomainsRequest) {
         ExecutionContext executionContext = createExecutionContext(listDomainsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<ListDomainsRequestrequest = null;
         Response<DomainInfosresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new ListDomainsRequestMarshaller().marshall(super.beforeMarshalling(listDomainsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DomainInfosJsonUnmarshallerContextunmarshaller =
                 new DomainInfosJsonUnmarshaller();
             JsonResponseHandler<DomainInfosresponseHandler =
                 new JsonResponseHandler<DomainInfos>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

NOTE:If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

NOTE:Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
requestCancelWorkflowExecutionRequest Container for the necessary parameters to execute the RequestCancelWorkflowExecution service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
 
     public void requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) {
         ExecutionContext executionContext = createExecutionContext(requestCancelWorkflowExecutionRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<RequestCancelWorkflowExecutionRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new RequestCancelWorkflowExecutionRequestMarshaller().marshall(super.beforeMarshalling(requestCancelWorkflowExecutionRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • workflowType.name : String constraint. The key is swf:workflowType.name .
    • workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
describeWorkflowTypeRequest Container for the necessary parameters to execute the DescribeWorkflowType service method on AmazonSimpleWorkflow.
Returns:
The response from the DescribeWorkflowType service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public WorkflowTypeDetail describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) {
        ExecutionContext executionContext = createExecutionContext(describeWorkflowTypeRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeWorkflowTypeRequestrequest = null;
        Response<WorkflowTypeDetailresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DescribeWorkflowTypeRequestMarshaller().marshall(super.beforeMarshalling(describeWorkflowTypeRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<WorkflowTypeDetailJsonUnmarshallerContextunmarshaller =
                new WorkflowTypeDetailJsonUnmarshaller();
            JsonResponseHandler<WorkflowTypeDetailresponseHandler =
                new JsonResponseHandler<WorkflowTypeDetail>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Deprecates the specified activity type . After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • activityType.name : String constraint. The key is swf:activityType.name .
    • activityType.version : String constraint. The key is swf:activityType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
deprecateActivityTypeRequest Container for the necessary parameters to execute the DeprecateActivityType service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.TypeDeprecatedException
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public void deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest) {
        ExecutionContext executionContext = createExecutionContext(deprecateActivityTypeRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DeprecateActivityTypeRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DeprecateActivityTypeRequestMarshaller().marshall(super.beforeMarshalling(deprecateActivityTypeRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag : String constraint. The key is swf:tagFilter.tag .
    • typeFilter.name : String constraint. The key is swf:typeFilter.name .
    • typeFilter.version : String constraint. The key is swf:typeFilter.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
countClosedWorkflowExecutionsRequest Container for the necessary parameters to execute the CountClosedWorkflowExecutions service method on AmazonSimpleWorkflow.
Returns:
The response from the CountClosedWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public WorkflowExecutionCount countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) {
        ExecutionContext executionContext = createExecutionContext(countClosedWorkflowExecutionsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CountClosedWorkflowExecutionsRequestrequest = null;
        Response<WorkflowExecutionCountresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CountClosedWorkflowExecutionsRequestMarshaller().marshall(super.beforeMarshalling(countClosedWorkflowExecutionsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<WorkflowExecutionCountJsonUnmarshallerContextunmarshaller =
                new WorkflowExecutionCountJsonUnmarshaller();
            JsonResponseHandler<WorkflowExecutionCountresponseHandler =
                new JsonResponseHandler<WorkflowExecutionCount>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
countPendingActivityTasksRequest Container for the necessary parameters to execute the CountPendingActivityTasks service method on AmazonSimpleWorkflow.
Returns:
The response from the CountPendingActivityTasks service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public PendingTaskCount countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest) {
        ExecutionContext executionContext = createExecutionContext(countPendingActivityTasksRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CountPendingActivityTasksRequestrequest = null;
        Response<PendingTaskCountresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CountPendingActivityTasksRequestMarshaller().marshall(super.beforeMarshalling(countPendingActivityTasksRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<PendingTaskCountJsonUnmarshallerContextunmarshaller =
                new PendingTaskCountJsonUnmarshaller();
            JsonResponseHandler<PendingTaskCountresponseHandler =
                new JsonResponseHandler<PendingTaskCount>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

IMPORTANT:Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out .

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
respondActivityTaskCanceledRequest Container for the necessary parameters to execute the RespondActivityTaskCanceled service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public void respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) {
        ExecutionContext executionContext = createExecutionContext(respondActivityTaskCanceledRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<RespondActivityTaskCanceledRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new RespondActivityTaskCanceledRequestMarshaller().marshall(super.beforeMarshalling(respondActivityTaskCanceledRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted , it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
respondDecisionTaskCompletedRequest Container for the necessary parameters to execute the RespondDecisionTaskCompleted service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public void respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) {
        ExecutionContext executionContext = createExecutionContext(respondDecisionTaskCompletedRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<RespondDecisionTaskCompletedRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new RespondDecisionTaskCompletedRequestMarshaller().marshall(super.beforeMarshalling(respondDecisionTaskCompletedRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

IMPORTANT: If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out .

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
respondActivityTaskCompletedRequest Container for the necessary parameters to execute the RespondActivityTaskCompleted service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public void respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) {
        ExecutionContext executionContext = createExecutionContext(respondActivityTaskCompletedRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<RespondActivityTaskCompletedRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new RespondActivityTaskCompletedRequestMarshaller().marshall(super.beforeMarshalling(respondActivityTaskCompletedRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Used by workers to get an ActivityTask from the specified activity taskList . This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

IMPORTANT:Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
pollForActivityTaskRequest Container for the necessary parameters to execute the PollForActivityTask service method on AmazonSimpleWorkflow.
Returns:
The response from the PollForActivityTask service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.services.simpleworkflow.model.LimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public ActivityTask pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest) {
        ExecutionContext executionContext = createExecutionContext(pollForActivityTaskRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<PollForActivityTaskRequestrequest = null;
        Response<ActivityTaskresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new PollForActivityTaskRequestMarshaller().marshall(super.beforeMarshalling(pollForActivityTaskRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<ActivityTaskJsonUnmarshallerContextunmarshaller =
                new ActivityTaskJsonUnmarshaller();
            JsonResponseHandler<ActivityTaskresponseHandler =
                new JsonResponseHandler<ActivityTask>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag : String constraint. The key is swf:tagFilter.tag .
    • typeFilter.name : String constraint. The key is swf:typeFilter.name .
    • typeFilter.version : String constraint. The key is swf:typeFilter.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
countOpenWorkflowExecutionsRequest Container for the necessary parameters to execute the CountOpenWorkflowExecutions service method on AmazonSimpleWorkflow.
Returns:
The response from the CountOpenWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public WorkflowExecutionCount countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) {
        ExecutionContext executionContext = createExecutionContext(countOpenWorkflowExecutionsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CountOpenWorkflowExecutionsRequestrequest = null;
        Response<WorkflowExecutionCountresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CountOpenWorkflowExecutionsRequestMarshaller().marshall(super.beforeMarshalling(countOpenWorkflowExecutionsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<WorkflowExecutionCountJsonUnmarshallerContextunmarshaller =
                new WorkflowExecutionCountJsonUnmarshaller();
            JsonResponseHandler<WorkflowExecutionCountresponseHandler =
                new JsonResponseHandler<WorkflowExecutionCount>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • activityType.name : String constraint. The key is swf:activityType.name .
    • activityType.version : String constraint. The key is swf:activityType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
describeActivityTypeRequest Container for the necessary parameters to execute the DescribeActivityType service method on AmazonSimpleWorkflow.
Returns:
The response from the DescribeActivityType service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public ActivityTypeDetail describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest) {
        ExecutionContext executionContext = createExecutionContext(describeActivityTypeRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeActivityTypeRequestrequest = null;
        Response<ActivityTypeDetailresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DescribeActivityTypeRequestMarshaller().marshall(super.beforeMarshalling(describeActivityTypeRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<ActivityTypeDetailJsonUnmarshallerContextunmarshaller =
                new ActivityTypeDetailJsonUnmarshaller();
            JsonResponseHandler<ActivityTypeDetailresponseHandler =
                new JsonResponseHandler<ActivityTypeDetail>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag : String constraint. The key is swf:tagFilter.tag .
    • typeFilter.name : String constraint. The key is swf:typeFilter.name .
    • typeFilter.version : String constraint. The key is swf:typeFilter.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
listOpenWorkflowExecutionsRequest Container for the necessary parameters to execute the ListOpenWorkflowExecutions service method on AmazonSimpleWorkflow.
Returns:
The response from the ListOpenWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public WorkflowExecutionInfos listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) {
        ExecutionContext executionContext = createExecutionContext(listOpenWorkflowExecutionsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ListOpenWorkflowExecutionsRequestrequest = null;
        Response<WorkflowExecutionInfosresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ListOpenWorkflowExecutionsRequestMarshaller().marshall(super.beforeMarshalling(listOpenWorkflowExecutionsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<WorkflowExecutionInfosJsonUnmarshallerContextunmarshaller =
                new WorkflowExecutionInfosJsonUnmarshaller();
            JsonResponseHandler<WorkflowExecutionInfosresponseHandler =
                new JsonResponseHandler<WorkflowExecutionInfos>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
getWorkflowExecutionHistoryRequest Container for the necessary parameters to execute the GetWorkflowExecutionHistory service method on AmazonSimpleWorkflow.
Returns:
The response from the GetWorkflowExecutionHistory service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public History getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) {
        ExecutionContext executionContext = createExecutionContext(getWorkflowExecutionHistoryRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<GetWorkflowExecutionHistoryRequestrequest = null;
        Response<Historyresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new GetWorkflowExecutionHistoryRequestMarshaller().marshall(super.beforeMarshalling(getWorkflowExecutionHistoryRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<HistoryJsonUnmarshallerContextunmarshaller =
                new HistoryJsonUnmarshaller();
            JsonResponseHandler<HistoryresponseHandler =
                new JsonResponseHandler<History>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Registers a new domain.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
registerDomainRequest Container for the necessary parameters to execute the RegisterDomain service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.DomainAlreadyExistsException
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.LimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public void registerDomain(RegisterDomainRequest registerDomainRequest) {
        ExecutionContext executionContext = createExecutionContext(registerDomainRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<RegisterDomainRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new RegisterDomainRequestMarshaller().marshall(super.beforeMarshalling(registerDomainRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Registers a new activity type along with its configuration settings in the specified domain.

IMPORTANT:A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • defaultTaskList.name : String constraint. The key is swf:defaultTaskList.name .
    • name : String constraint. The key is swf:name .
    • version : String constraint. The key is swf:version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
registerActivityTypeRequest Container for the necessary parameters to execute the RegisterActivityType service method on AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.services.simpleworkflow.model.TypeAlreadyExistsException
com.amazonaws.services.simpleworkflow.model.LimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public void registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest) {
        ExecutionContext executionContext = createExecutionContext(registerActivityTypeRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<RegisterActivityTypeRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new RegisterActivityTypeRequestMarshaller().marshall(super.beforeMarshalling(registerActivityTypeRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag : String constraint. The key is swf:tagFilter.tag .
    • typeFilter.name : String constraint. The key is swf:typeFilter.name .
    • typeFilter.version : String constraint. The key is swf:typeFilter.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
listClosedWorkflowExecutionsRequest Container for the necessary parameters to execute the ListClosedWorkflowExecutions service method on AmazonSimpleWorkflow.
Returns:
The response from the ListClosedWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public WorkflowExecutionInfos listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) {
        ExecutionContext executionContext = createExecutionContext(listClosedWorkflowExecutionsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ListClosedWorkflowExecutionsRequestrequest = null;
        Response<WorkflowExecutionInfosresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ListClosedWorkflowExecutionsRequestMarshaller().marshall(super.beforeMarshalling(listClosedWorkflowExecutionsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<WorkflowExecutionInfosJsonUnmarshallerContextunmarshaller =
                new WorkflowExecutionInfosJsonUnmarshaller();
            JsonResponseHandler<WorkflowExecutionInfosresponseHandler =
                new JsonResponseHandler<WorkflowExecutionInfos>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true .

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

NOTE:The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

NOTE:This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

IMPORTANT:If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Parameters:
recordActivityTaskHeartbeatRequest Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method on AmazonSimpleWorkflow.
Returns:
The response from the RecordActivityTaskHeartbeat service method, as returned by AmazonSimpleWorkflow.
Throws:
com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException
com.amazonaws.services.simpleworkflow.model.UnknownResourceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.
    public ActivityTaskStatus recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) {
        ExecutionContext executionContext = createExecutionContext(recordActivityTaskHeartbeatRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<RecordActivityTaskHeartbeatRequestrequest = null;
        Response<ActivityTaskStatusresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new RecordActivityTaskHeartbeatRequestMarshaller().marshall(super.beforeMarshalling(recordActivityTaskHeartbeatRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }