Amazonka.Transfer.ListExecutions

Lists all executions for the specified workflow.

This operation returns paginated results.

Creating a Request

data ListExecutions

See: newListExecutions smart constructor.

Constructors

ListExecutions'

Fields

• maxResults :: Maybe Natural

  Specifies the maximum number of executions to return.

• nextToken :: Maybe Text

  ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

  This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

  aws transfer list-executions --max-results 10

  This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

  aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

  This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

• workflowId :: Text

  A unique identifier for the workflow.

Instances

ToJSON ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

toJSON :: ListExecutions -> Value

toEncoding :: ListExecutions -> Encoding

toJSONList :: [ListExecutions] -> Value

toEncodingList :: [ListExecutions] -> Encoding

ToHeaders ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

toHeaders :: ListExecutions -> [Header]

ToPath ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

toPath :: ListExecutions -> ByteString

ToQuery ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

toQuery :: ListExecutions -> QueryString

AWSPager ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

page :: ListExecutions -> AWSResponse ListExecutions -> Maybe ListExecutions

AWSRequest ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Associated Types

type AWSResponse ListExecutions

Methods

request :: (Service -> Service) -> ListExecutions -> Request ListExecutions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExecutions)))

Generic ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Associated Types

type Rep ListExecutions :: Type -> Type

Methods

from :: ListExecutions -> Rep ListExecutions x

to :: Rep ListExecutions x -> ListExecutions

Read ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

readsPrec :: Int -> ReadS ListExecutions

readList :: ReadS [ListExecutions]

readPrec :: ReadPrec ListExecutions

readListPrec :: ReadPrec [ListExecutions]

Show ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

showsPrec :: Int -> ListExecutions -> ShowS

show :: ListExecutions -> String

showList :: [ListExecutions] -> ShowS

NFData ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

rnf :: ListExecutions -> ()

Eq ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

(==) :: ListExecutions -> ListExecutions -> Bool

(/=) :: ListExecutions -> ListExecutions -> Bool

Hashable ListExecutions

Defined in Amazonka.Transfer.ListExecutions

Methods

hashWithSalt :: Int -> ListExecutions -> Int

hash :: ListExecutions -> Int

type AWSResponse ListExecutions

Defined in Amazonka.Transfer.ListExecutions

type AWSResponse ListExecutions = ListExecutionsResponse

type Rep ListExecutions

Defined in Amazonka.Transfer.ListExecutions

type Rep ListExecutions = D1 ('MetaData "ListExecutions" "Amazonka.Transfer.ListExecutions" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListExecutions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListExecutions

Arguments

:: Text

ListExecutions

-> ListExecutions

Create a value of ListExecutions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListExecutions', listExecutions_maxResults - Specifies the maximum number of executions to return.

ListExecutions, listExecutions_nextToken - ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

ListExecutions, listExecutions_workflowId - A unique identifier for the workflow.

Request Lenses

listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural)

Specifies the maximum number of executions to return.

listExecutions_nextToken :: Lens' ListExecutions (Maybe Text)

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

listExecutions_workflowId :: Lens' ListExecutions Text

A unique identifier for the workflow.

Destructuring the Response

data ListExecutionsResponse

See: newListExecutionsResponse smart constructor.

Constructors

ListExecutionsResponse'

Fields

• nextToken :: Maybe Text

  ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

• httpStatus :: Int

  The response's http status code.

• workflowId :: Text

  A unique identifier for the workflow.

• executions :: [ListedExecution]

  Returns the details for each execution.

  • NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
  • StartTime: timestamp indicating when the execution began.
  • Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
  • Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.

Instances

Generic ListExecutionsResponse

Defined in Amazonka.Transfer.ListExecutions

Associated Types

type Rep ListExecutionsResponse :: Type -> Type

Methods

from :: ListExecutionsResponse -> Rep ListExecutionsResponse x

to :: Rep ListExecutionsResponse x -> ListExecutionsResponse

Read ListExecutionsResponse

Defined in Amazonka.Transfer.ListExecutions

Methods

readsPrec :: Int -> ReadS ListExecutionsResponse

readList :: ReadS [ListExecutionsResponse]

readPrec :: ReadPrec ListExecutionsResponse

readListPrec :: ReadPrec [ListExecutionsResponse]

Show ListExecutionsResponse

Defined in Amazonka.Transfer.ListExecutions

Methods

showsPrec :: Int -> ListExecutionsResponse -> ShowS

show :: ListExecutionsResponse -> String

showList :: [ListExecutionsResponse] -> ShowS

NFData ListExecutionsResponse

Defined in Amazonka.Transfer.ListExecutions

Methods

rnf :: ListExecutionsResponse -> ()

Eq ListExecutionsResponse

Defined in Amazonka.Transfer.ListExecutions

Methods

(==) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool

(/=) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool

type Rep ListExecutionsResponse

Defined in Amazonka.Transfer.ListExecutions

type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.Transfer.ListExecutions" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListExecutionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedExecution]))))

newListExecutionsResponse

Arguments

:: Int

$sel:httpStatus:ListExecutionsResponse'

-> Text

ListExecutions

-> ListExecutionsResponse

Create a value of ListExecutionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListExecutions, listExecutionsResponse_nextToken - ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

$sel:httpStatus:ListExecutionsResponse', listExecutionsResponse_httpStatus - The response's http status code.

ListExecutions, listExecutionsResponse_workflowId - A unique identifier for the workflow.

$sel:executions:ListExecutionsResponse', listExecutionsResponse_executions - Returns the details for each execution.

• NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
• StartTime: timestamp indicating when the execution began.
• Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
• Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.

Response Lenses

listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text)

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

listExecutionsResponse_httpStatus :: Lens' ListExecutionsResponse Int

The response's http status code.

listExecutionsResponse_workflowId :: Lens' ListExecutionsResponse Text

A unique identifier for the workflow.

listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ListedExecution]

Returns the details for each execution.

• NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
• StartTime: timestamp indicating when the execution began.
• Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
• Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.