amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.ListWorkflows

Description

Lists all of your workflows.

This operation returns paginated results.

Synopsis

Creating a Request

data ListWorkflows Source #

See: newListWorkflows smart constructor.

Constructors

ListWorkflows' 

Fields

  • maxResults :: Maybe Natural

    Specifies the maximum number of workflows to return.

  • nextToken :: Maybe Text

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

Instances

Instances details
ToJSON ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

ToHeaders ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

ToPath ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

ToQuery ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

AWSPager ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

AWSRequest ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Associated Types

type AWSResponse ListWorkflows #

Generic ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Associated Types

type Rep ListWorkflows :: Type -> Type #

Read ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Show ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

NFData ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Methods

rnf :: ListWorkflows -> () #

Eq ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Hashable ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type AWSResponse ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type Rep ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

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

newListWorkflows :: ListWorkflows Source #

Create a value of ListWorkflows 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:ListWorkflows', listWorkflows_maxResults - Specifies the maximum number of workflows to return.

ListWorkflows, listWorkflows_nextToken - ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

Request Lenses

listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural) Source #

Specifies the maximum number of workflows to return.

listWorkflows_nextToken :: Lens' ListWorkflows (Maybe Text) Source #

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

Destructuring the Response

data ListWorkflowsResponse Source #

See: newListWorkflowsResponse smart constructor.

Constructors

ListWorkflowsResponse' 

Fields

  • nextToken :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

  • workflows :: [ListedWorkflow]

    Returns the Arn, WorkflowId, and Description for each workflow.

Instances

Instances details
Generic ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Associated Types

type Rep ListWorkflowsResponse :: Type -> Type #

Read ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Show ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

NFData ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Methods

rnf :: ListWorkflowsResponse -> () #

Eq ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type Rep ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

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

newListWorkflowsResponse Source #

Create a value of ListWorkflowsResponse 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:

ListWorkflows, listWorkflowsResponse_nextToken - ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

$sel:httpStatus:ListWorkflowsResponse', listWorkflowsResponse_httpStatus - The response's http status code.

$sel:workflows:ListWorkflowsResponse', listWorkflowsResponse_workflows - Returns the Arn, WorkflowId, and Description for each workflow.

Response Lenses

listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text) Source #

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

listWorkflowsResponse_workflows :: Lens' ListWorkflowsResponse [ListedWorkflow] Source #

Returns the Arn, WorkflowId, and Description for each workflow.