/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the swf-2012-01-25.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.SimpleWorkflow.Model
{
///
/// Container for the parameters to the SignalWorkflowExecution operation.
/// 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).
///
///
///
/// If a runId isn't specified, then the WorkflowExecutionSignaled
event
/// is recorded in the history of the current open workflow with the matching workflowId
/// in the domain.
///
///
///
/// If the specified workflow execution isn't 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 doesn't 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 is set to OPERATION_NOT_PERMITTED
.
/// For details and example IAM policies, see Using
/// IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
///
///
public partial class SignalWorkflowExecutionRequest : AmazonSimpleWorkflowRequest
{
private string _domain;
private string _input;
private string _runId;
private string _signalName;
private string _workflowId;
///
/// Gets and sets the property Domain.
///
/// The name of the domain containing the workflow execution to signal.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string Domain
{
get { return this._domain; }
set { this._domain = value; }
}
// Check to see if Domain property is set
internal bool IsSetDomain()
{
return this._domain != null;
}
///
/// Gets and sets the property Input.
///
/// Data to attach to the WorkflowExecutionSignaled
event in the target workflow
/// execution's history.
///
///
[AWSProperty(Max=32768)]
public string Input
{
get { return this._input; }
set { this._input = value; }
}
// Check to see if Input property is set
internal bool IsSetInput()
{
return this._input != null;
}
///
/// Gets and sets the property RunId.
///
/// The runId of the workflow execution to signal.
///
///
[AWSProperty(Max=64)]
public string RunId
{
get { return this._runId; }
set { this._runId = value; }
}
// Check to see if RunId property is set
internal bool IsSetRunId()
{
return this._runId != null;
}
///
/// Gets and sets the property SignalName.
///
/// The name of the signal. This name must be meaningful to the target workflow.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string SignalName
{
get { return this._signalName; }
set { this._signalName = value; }
}
// Check to see if SignalName property is set
internal bool IsSetSignalName()
{
return this._signalName != null;
}
///
/// Gets and sets the property WorkflowId.
///
/// The workflowId of the workflow execution to signal.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string WorkflowId
{
get { return this._workflowId; }
set { this._workflowId = value; }
}
// Check to see if WorkflowId property is set
internal bool IsSetWorkflowId()
{
return this._workflowId != null;
}
}
}