Struct aws_sdk_sfn::client::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS Step Functions
Client for invoking operations on AWS Step Functions. Each operation on AWS Step Functions is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_sfn::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_sfn::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_sfn::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_activity(&self) -> CreateActivity
pub fn create_activity(&self) -> CreateActivity
Constructs a fluent builder for the CreateActivity
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
“ # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The list of tags to add to a resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @
.
- On success, responds with
CreateActivityOutput
with field(s):activity_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the created activity.
creation_date(Option<DateTime>)
:The date the activity is created.
- On failure, responds with
SdkError<CreateActivityError>
sourcepub fn create_state_machine(&self) -> CreateStateMachine
pub fn create_state_machine(&self) -> CreateStateMachine
Constructs a fluent builder for the CreateStateMachine
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
“ # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
-
definition(impl Into<String>)
/set_definition(Option<String>)
:The Amazon States Language definition of the state machine. See Amazon States Language.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
r#type(StateMachineType)
/set_type(Option<StateMachineType>)
:Determines whether a Standard or Express state machine is created. The default is
STANDARD
. You cannot update thetype
of a state machine once it has been created.logging_configuration(LoggingConfiguration)
/set_logging_configuration(Option<LoggingConfiguration>)
:Defines what execution history events are logged and where they are logged.
By default, the
level
is set toOFF
. For more information see Log Levels in the AWS Step Functions User Guide.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags to be added when creating a state machine.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @
.tracing_configuration(TracingConfiguration)
/set_tracing_configuration(Option<TracingConfiguration>)
:Selects whether AWS X-Ray tracing is enabled.
- On success, responds with
CreateStateMachineOutput
with field(s):state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the created state machine.
creation_date(Option<DateTime>)
:The date the state machine is created.
- On failure, responds with
SdkError<CreateStateMachineError>
sourcepub fn delete_activity(&self) -> DeleteActivity
pub fn delete_activity(&self) -> DeleteActivity
Constructs a fluent builder for the DeleteActivity
operation.
- The fluent builder is configurable:
activity_arn(impl Into<String>)
/set_activity_arn(Option<String>)
:The Amazon Resource Name (ARN) of the activity to delete.
- On success, responds with
DeleteActivityOutput
- On failure, responds with
SdkError<DeleteActivityError>
sourcepub fn delete_state_machine(&self) -> DeleteStateMachine
pub fn delete_state_machine(&self) -> DeleteStateMachine
Constructs a fluent builder for the DeleteStateMachine
operation.
- The fluent builder is configurable:
state_machine_arn(impl Into<String>)
/set_state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine to delete.
- On success, responds with
DeleteStateMachineOutput
- On failure, responds with
SdkError<DeleteStateMachineError>
sourcepub fn describe_activity(&self) -> DescribeActivity
pub fn describe_activity(&self) -> DescribeActivity
Constructs a fluent builder for the DescribeActivity
operation.
- The fluent builder is configurable:
activity_arn(impl Into<String>)
/set_activity_arn(Option<String>)
:The Amazon Resource Name (ARN) of the activity to describe.
- On success, responds with
DescribeActivityOutput
with field(s):activity_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the activity.
name(Option<String>)
:The name of the activity.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
“ # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
-
creation_date(Option<DateTime>)
:The date the activity is created.
- On failure, responds with
SdkError<DescribeActivityError>
sourcepub fn describe_execution(&self) -> DescribeExecution
pub fn describe_execution(&self) -> DescribeExecution
Constructs a fluent builder for the DescribeExecution
operation.
- The fluent builder is configurable:
execution_arn(impl Into<String>)
/set_execution_arn(Option<String>)
:The Amazon Resource Name (ARN) of the execution to describe.
- On success, responds with
DescribeExecutionOutput
with field(s):execution_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the execution.
state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the executed stated machine.
name(Option<String>)
:The name of the execution.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
“ # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
-
status(Option<ExecutionStatus>)
:The current status of the execution.
start_date(Option<DateTime>)
:The date the execution is started.
stop_date(Option<DateTime>)
:If the execution has already ended, the date the execution stopped.
input(Option<String>)
:The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
input_details(Option<CloudWatchEventsExecutionDataDetails>)
:Provides details about execution input or output.
output(Option<String>)
:The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
output_details(Option<CloudWatchEventsExecutionDataDetails>)
:Provides details about execution input or output.
trace_header(Option<String>)
:The AWS X-Ray trace header that was passed to the execution.
- On failure, responds with
SdkError<DescribeExecutionError>
sourcepub fn describe_state_machine(&self) -> DescribeStateMachine
pub fn describe_state_machine(&self) -> DescribeStateMachine
Constructs a fluent builder for the DescribeStateMachine
operation.
- The fluent builder is configurable:
state_machine_arn(impl Into<String>)
/set_state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine to describe.
- On success, responds with
DescribeStateMachineOutput
with field(s):state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the state machine.
name(Option<String>)
:The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
“ # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
-
status(Option<StateMachineStatus>)
:The current status of the state machine.
definition(Option<String>)
:The Amazon States Language definition of the state machine. See Amazon States Language.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)
r#type(Option<StateMachineType>)
:The
type
of the state machine (STANDARD
orEXPRESS
).creation_date(Option<DateTime>)
:The date the state machine is created.
logging_configuration(Option<LoggingConfiguration>)
:The
LoggingConfiguration
data type is used to set CloudWatch Logs options.tracing_configuration(Option<TracingConfiguration>)
:Selects whether AWS X-Ray tracing is enabled.
- On failure, responds with
SdkError<DescribeStateMachineError>
sourcepub fn describe_state_machine_for_execution(
&self
) -> DescribeStateMachineForExecution
pub fn describe_state_machine_for_execution(
&self
) -> DescribeStateMachineForExecution
Constructs a fluent builder for the DescribeStateMachineForExecution
operation.
- The fluent builder is configurable:
execution_arn(impl Into<String>)
/set_execution_arn(Option<String>)
:The Amazon Resource Name (ARN) of the execution you want state machine information for.
- On success, responds with
DescribeStateMachineForExecutionOutput
with field(s):state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine associated with the execution.
name(Option<String>)
:The name of the state machine associated with the execution.
definition(Option<String>)
:The Amazon States Language definition of the state machine. See Amazon States Language.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
update_date(Option<DateTime>)
:The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
logging_configuration(Option<LoggingConfiguration>)
:The
LoggingConfiguration
data type is used to set CloudWatch Logs options.tracing_configuration(Option<TracingConfiguration>)
:Selects whether AWS X-Ray tracing is enabled.
- On failure, responds with
SdkError<DescribeStateMachineForExecutionError>
sourcepub fn get_activity_task(&self) -> GetActivityTask
pub fn get_activity_task(&self) -> GetActivityTask
Constructs a fluent builder for the GetActivityTask
operation.
- The fluent builder is configurable:
activity_arn(impl Into<String>)
/set_activity_arn(Option<String>)
:The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using
CreateActivity
.)worker_name(impl Into<String>)
/set_worker_name(Option<String>)
:You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
- On success, responds with
GetActivityTaskOutput
with field(s):task_token(Option<String>)
:A token that identifies the scheduled task. This token must be copied and included in subsequent calls to
SendTaskHeartbeat
,SendTaskSuccess
orSendTaskFailure
in order to report the progress or completion of the task.input(Option<String>)
:The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- On failure, responds with
SdkError<GetActivityTaskError>
sourcepub fn get_execution_history(&self) -> GetExecutionHistory
pub fn get_execution_history(&self) -> GetExecutionHistory
Constructs a fluent builder for the GetExecutionHistory
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
execution_arn(impl Into<String>)
/set_execution_arn(Option<String>)
:The Amazon Resource Name (ARN) of the execution.
max_results(i32)
/set_max_results(i32)
:The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
reverse_order(bool)
/set_reverse_order(bool)
:Lists events in descending order of their
timeStamp
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.include_execution_data(bool)
/set_include_execution_data(Option<bool>)
:You can select whether execution data (input or output of a history event) is returned. The default is
true
.
- On success, responds with
GetExecutionHistoryOutput
with field(s):events(Option<Vec<HistoryEvent>>)
:The list of events that occurred in the execution.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<GetExecutionHistoryError>
sourcepub fn list_activities(&self) -> ListActivities
pub fn list_activities(&self) -> ListActivities
Constructs a fluent builder for the ListActivities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On success, responds with
ListActivitiesOutput
with field(s):activities(Option<Vec<ActivityListItem>>)
:The list of activities.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListActivitiesError>
sourcepub fn list_executions(&self) -> ListExecutions
pub fn list_executions(&self) -> ListExecutions
Constructs a fluent builder for the ListExecutions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
state_machine_arn(impl Into<String>)
/set_state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine whose executions is listed.
status_filter(ExecutionStatus)
/set_status_filter(Option<ExecutionStatus>)
:If specified, only list the executions whose current execution status matches the given filter.
max_results(i32)
/set_max_results(i32)
:The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On success, responds with
ListExecutionsOutput
with field(s):executions(Option<Vec<ExecutionListItem>>)
:The list of matching executions.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListExecutionsError>
sourcepub fn list_state_machines(&self) -> ListStateMachines
pub fn list_state_machines(&self) -> ListStateMachines
Constructs a fluent builder for the ListStateMachines
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On success, responds with
ListStateMachinesOutput
with field(s):state_machines(Option<Vec<StateMachineListItem>>)
: (undocumented)next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListStateMachinesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:An array of tags associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn send_task_failure(&self) -> SendTaskFailure
pub fn send_task_failure(&self) -> SendTaskFailure
Constructs a fluent builder for the SendTaskFailure
operation.
- The fluent builder is configurable:
task_token(impl Into<String>)
/set_task_token(Option<String>)
:The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See
GetActivityTaskOutput$taskToken
.error(impl Into<String>)
/set_error(Option<String>)
:The error code of the failure.
cause(impl Into<String>)
/set_cause(Option<String>)
:A more detailed explanation of the cause of the failure.
- On success, responds with
SendTaskFailureOutput
- On failure, responds with
SdkError<SendTaskFailureError>
sourcepub fn send_task_heartbeat(&self) -> SendTaskHeartbeat
pub fn send_task_heartbeat(&self) -> SendTaskHeartbeat
Constructs a fluent builder for the SendTaskHeartbeat
operation.
- The fluent builder is configurable:
task_token(impl Into<String>)
/set_task_token(Option<String>)
:The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See
GetActivityTaskOutput$taskToken
.
- On success, responds with
SendTaskHeartbeatOutput
- On failure, responds with
SdkError<SendTaskHeartbeatError>
sourcepub fn send_task_success(&self) -> SendTaskSuccess
pub fn send_task_success(&self) -> SendTaskSuccess
Constructs a fluent builder for the SendTaskSuccess
operation.
- The fluent builder is configurable:
task_token(impl Into<String>)
/set_task_token(Option<String>)
:The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See
GetActivityTaskOutput$taskToken
.output(impl Into<String>)
/set_output(Option<String>)
:The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- On success, responds with
SendTaskSuccessOutput
- On failure, responds with
SdkError<SendTaskSuccessError>
sourcepub fn start_execution(&self) -> StartExecution
pub fn start_execution(&self) -> StartExecution
Constructs a fluent builder for the StartExecution
operation.
- The fluent builder is configurable:
state_machine_arn(impl Into<String>)
/set_state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine to execute.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
“ # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
-
input(impl Into<String>)
/set_input(Option<String>)
:The string that contains the JSON input data for the execution, for example:
“input”: “{"first_name" : "test"}”
If you don’t include any JSON input data, you still must include the two braces, for example:
“input”: “{}”
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
trace_header(impl Into<String>)
/set_trace_header(Option<String>)
:Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.
- On success, responds with
StartExecutionOutput
with field(s):execution_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the execution.
start_date(Option<DateTime>)
:The date the execution is started.
- On failure, responds with
SdkError<StartExecutionError>
sourcepub fn start_sync_execution(&self) -> StartSyncExecution
pub fn start_sync_execution(&self) -> StartSyncExecution
Constructs a fluent builder for the StartSyncExecution
operation.
- The fluent builder is configurable:
state_machine_arn(impl Into<String>)
/set_state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine to execute.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the execution.
input(impl Into<String>)
/set_input(Option<String>)
:The string that contains the JSON input data for the execution, for example:
“input”: “{"first_name" : "test"}”
If you don’t include any JSON input data, you still must include the two braces, for example:
“input”: “{}”
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
trace_header(impl Into<String>)
/set_trace_header(Option<String>)
:Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.
- On success, responds with
StartSyncExecutionOutput
with field(s):execution_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the execution.
state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the state machine.
name(Option<String>)
:The name of the execution.
start_date(Option<DateTime>)
:The date the execution is started.
stop_date(Option<DateTime>)
:If the execution has already ended, the date the execution stopped.
status(Option<SyncExecutionStatus>)
:The current status of the execution.
error(Option<String>)
:The error code of the failure.
cause(Option<String>)
:A more detailed explanation of the cause of the failure.
input(Option<String>)
:The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
input_details(Option<CloudWatchEventsExecutionDataDetails>)
:Provides details about execution input or output.
output(Option<String>)
:The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
output_details(Option<CloudWatchEventsExecutionDataDetails>)
:Provides details about execution input or output.
trace_header(Option<String>)
:The AWS X-Ray trace header that was passed to the execution.
billing_details(Option<BillingDetails>)
:An object that describes workflow billing details, including billed duration and memory use.
- On failure, responds with
SdkError<StartSyncExecutionError>
sourcepub fn stop_execution(&self) -> StopExecution
pub fn stop_execution(&self) -> StopExecution
Constructs a fluent builder for the StopExecution
operation.
- The fluent builder is configurable:
execution_arn(impl Into<String>)
/set_execution_arn(Option<String>)
:The Amazon Resource Name (ARN) of the execution to stop.
error(impl Into<String>)
/set_error(Option<String>)
:The error code of the failure.
cause(impl Into<String>)
/set_cause(Option<String>)
:A more detailed explanation of the cause of the failure.
- On success, responds with
StopExecutionOutput
with field(s):stop_date(Option<DateTime>)
:The date the execution is stopped.
- On failure, responds with
SdkError<StopExecutionError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The list of tags to add to a resource.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @
.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The list of tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_state_machine(&self) -> UpdateStateMachine
pub fn update_state_machine(&self) -> UpdateStateMachine
Constructs a fluent builder for the UpdateStateMachine
operation.
- The fluent builder is configurable:
state_machine_arn(impl Into<String>)
/set_state_machine_arn(Option<String>)
:The Amazon Resource Name (ARN) of the state machine.
definition(impl Into<String>)
/set_definition(Option<String>)
:The Amazon States Language definition of the state machine. See Amazon States Language.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role of the state machine.
logging_configuration(LoggingConfiguration)
/set_logging_configuration(Option<LoggingConfiguration>)
:The
LoggingConfiguration
data type is used to set CloudWatch Logs options.tracing_configuration(TracingConfiguration)
/set_tracing_configuration(Option<TracingConfiguration>)
:Selects whether AWS X-Ray tracing is enabled.
- On success, responds with
UpdateStateMachineOutput
with field(s):update_date(Option<DateTime>)
:The date and time the state machine was updated.
- On failure, responds with
SdkError<UpdateStateMachineError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more