Skip to content

List State Machine Aliases

sfn_list_state_machine_aliases R Documentation

Lists aliases for a specified state machine ARN

Description

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

If nextToken is returned, there are more results available. The value of nextToken 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.

Related operations:

  • create_state_machine_alias

  • describe_state_machine_alias

  • update_state_machine_alias

  • delete_state_machine_alias

Usage

sfn_list_state_machine_aliases(stateMachineArn, nextToken, maxResults)

Arguments

stateMachineArn

[required] The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

If you specify a state machine version ARN, this API returns a list of aliases for that version.

nextToken

If nextToken is returned, there are more results available. The value of nextToken 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.

maxResults

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.

Value

A list with the following syntax: 

list(
  stateMachineAliases = list(
    list(
      stateMachineAliasArn = "string",
      creationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_state_machine_aliases(
  stateMachineArn = "string",
  nextToken = "string",
  maxResults = 123
)