Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.ListExecutions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all executions for the specified workflow.

Synopsis

data ListExecutions = ListExecutions' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- workflowId :: Text
}
newListExecutions :: Text -> ListExecutions
listExecutions_nextToken :: Lens' ListExecutions (Maybe Text)
listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural)
listExecutions_workflowId :: Lens' ListExecutions Text
data ListExecutionsResponse = ListExecutionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- workflowId :: Text
- executions :: [ListedExecution]
}
newListExecutionsResponse :: Int -> Text -> ListExecutionsResponse
listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text)
listExecutionsResponse_httpStatus :: Lens' ListExecutionsResponse Int
listExecutionsResponse_workflowId :: Lens' ListExecutionsResponse Text
listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ListedExecution]

Creating a Request

data ListExecutions Source #

See: newListExecutions smart constructor.

Constructors

ListExecutions'

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.
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, callthe API by specifing 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, suppling 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.
maxResults :: Maybe Natural
Specifies the aximum number of executions to return.
workflowId :: Text
A unique identifier for the workflow.

Instances

Instances details

Eq ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods (==) :: ListExecutions -> ListExecutions -> Bool # (/=) :: ListExecutions -> ListExecutions -> Bool #
Read ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods readsPrec :: Int -> ReadS ListExecutions # readList :: ReadS [ListExecutions] # readPrec :: ReadPrec ListExecutions # readListPrec :: ReadPrec [ListExecutions] #
Show ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods showsPrec :: Int -> ListExecutions -> ShowS # show :: ListExecutions -> String # showList :: [ListExecutions] -> ShowS #
Generic ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Associated Types type Rep ListExecutions :: Type -> Type # Methods from :: ListExecutions -> Rep ListExecutions x # to :: Rep ListExecutions x -> ListExecutions #
NFData ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods rnf :: ListExecutions -> () #
Hashable ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods hashWithSalt :: Int -> ListExecutions -> Int # hash :: ListExecutions -> Int #
ToJSON ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toJSON :: ListExecutions -> Value # toEncoding :: ListExecutions -> Encoding # toJSONList :: [ListExecutions] -> Value # toEncodingList :: [ListExecutions] -> Encoding #
AWSRequest ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Associated Types type AWSResponse ListExecutions # Methods request :: ListExecutions -> Request ListExecutions # response :: MonadResource m => Logger -> Service -> Proxy ListExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExecutions))) #
ToHeaders ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toHeaders :: ListExecutions -> [Header] #
ToPath ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toPath :: ListExecutions -> ByteString #
ToQuery ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toQuery :: ListExecutions -> QueryString #
type Rep ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions type Rep ListExecutions = D1 ('MetaData "ListExecutions" "Amazonka.Transfer.ListExecutions" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListExecutions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions type AWSResponse ListExecutions = ListExecutionsResponse

newListExecutions Source #

Arguments

:: Text	`$sel:workflowId: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:nextToken: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, callthe API by specifing 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, suppling 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.

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

$sel:workflowId:ListExecutions', listExecutions_workflowId - A unique identifier for the workflow.

Request Lenses

listExecutions_nextToken :: Lens' ListExecutions (Maybe Text) Source #

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, callthe API by specifing 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, suppling 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_maxResults :: Lens' ListExecutions (Maybe Natural) Source #

Specifies the aximum number of executions to return.

listExecutions_workflowId :: Lens' ListExecutions Text Source #

A unique identifier for the workflow.

Destructuring the Response

data ListExecutionsResponse Source #

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

Instances details

Eq ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods (==) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool # (/=) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool #
Read ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods readsPrec :: Int -> ReadS ListExecutionsResponse # readList :: ReadS [ListExecutionsResponse] # readPrec :: ReadPrec ListExecutionsResponse # readListPrec :: ReadPrec [ListExecutionsResponse] #
Show ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods showsPrec :: Int -> ListExecutionsResponse -> ShowS # show :: ListExecutionsResponse -> String # showList :: [ListExecutionsResponse] -> ShowS #
Generic ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Associated Types type Rep ListExecutionsResponse :: Type -> Type # Methods from :: ListExecutionsResponse -> Rep ListExecutionsResponse x # to :: Rep ListExecutionsResponse x -> ListExecutionsResponse #
NFData ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods rnf :: ListExecutionsResponse -> () #
type Rep ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.Transfer.ListExecutions" "libZSservicesZSamazonka-transferZSamazonka-transfer" '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 Source #

Arguments

:: Int	`$sel:httpStatus:ListExecutionsResponse'`
-> Text	`$sel:workflowId: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:

$sel:nextToken: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.

$sel:workflowId: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) Source #

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 Source #

The response's http status code.

listExecutionsResponse_workflowId :: Lens' ListExecutionsResponse Text Source #

A unique identifier for the workflow.

listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ListedExecution] Source #

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.