Package software.amazon.awssdk.services.sfn.model

Interface ListExecutionsRequest.Builder

    • Method Detail

      • stateMachineArn

        ListExecutionsRequest.Builder stateMachineArn​(String stateMachineArn)

        The Amazon Resource Name (ARN) of the state machine whose executions is listed.

        You can specify either a mapRunArn or a stateMachineArn, but not both.

        You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

        Parameters:
        stateMachineArn - The Amazon Resource Name (ARN) of the state machine whose executions is listed.

        You can specify either a mapRunArn or a stateMachineArn, but not both.

        You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusFilter

        ListExecutionsRequest.Builder statusFilter​(String statusFilter)

        If specified, only list the executions whose current execution status matches the given filter.

        Parameters:
        statusFilter - If specified, only list the executions whose current execution status matches the given filter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExecutionStatus, ExecutionStatus

      • statusFilter

        ListExecutionsRequest.Builder statusFilter​(ExecutionStatus statusFilter)

        If specified, only list the executions whose current execution status matches the given filter.

        Parameters:
        statusFilter - If specified, only list the executions whose current execution status matches the given filter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExecutionStatus, ExecutionStatus

      • maxResults

        ListExecutionsRequest.Builder maxResults​(Integer 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListExecutionsRequest.Builder nextToken​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mapRunArn

        ListExecutionsRequest.Builder mapRunArn​(String mapRunArn)

        The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

        You can specify either a mapRunArn or a stateMachineArn, but not both.

        Parameters:
        mapRunArn - The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

        You can specify either a mapRunArn or a stateMachineArn, but not both.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • redriveFilter

        ListExecutionsRequest.Builder redriveFilter​(String redriveFilter)

        Sets a filter to list executions based on whether or not they have been redriven.

        For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

        If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

        If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

        Parameters:
        redriveFilter - Sets a filter to list executions based on whether or not they have been redriven.

        For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

        If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

        If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExecutionRedriveFilter, ExecutionRedriveFilter

      • redriveFilter

        ListExecutionsRequest.Builder redriveFilter​(ExecutionRedriveFilter redriveFilter)

        Sets a filter to list executions based on whether or not they have been redriven.

        For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

        If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

        If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

        Parameters:
        redriveFilter - Sets a filter to list executions based on whether or not they have been redriven.

        For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

        If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

        If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExecutionRedriveFilter, ExecutionRedriveFilter