libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConnect.ListFlows

Description

Displays a list of flows that are associated with this account. This request returns a paginated result.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFlows Source #

See: newListFlows smart constructor.

Constructors

ListFlows' 

Fields

  • nextToken :: Maybe Text

    The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

  • maxResults :: Maybe Natural

    The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

Instances

Instances details
Eq ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Read ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Show ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Generic ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Associated Types

type Rep ListFlows :: Type -> Type #

NFData ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Methods

rnf :: ListFlows -> () #

Hashable ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

AWSPager ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

AWSRequest ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Associated Types

type AWSResponse ListFlows #

ToHeaders ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Methods

toHeaders :: ListFlows -> [Header] #

ToPath ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

ToQuery ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

type Rep ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

type Rep ListFlows = D1 ('MetaData "ListFlows" "Amazonka.MediaConnect.ListFlows" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "ListFlows'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListFlows Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

newListFlows :: ListFlows Source #

Create a value of ListFlows 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:ListFlows', listFlows_nextToken - The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

$sel:maxResults:ListFlows', listFlows_maxResults - The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

Request Lenses

listFlows_nextToken :: Lens' ListFlows (Maybe Text) Source #

The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

listFlows_maxResults :: Lens' ListFlows (Maybe Natural) Source #

The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

Destructuring the Response

data ListFlowsResponse Source #

See: newListFlowsResponse smart constructor.

Constructors

ListFlowsResponse' 

Fields

  • nextToken :: Maybe Text

    The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

  • flows :: Maybe [ListedFlow]

    A list of flow summaries.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListFlowsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Read ListFlowsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Show ListFlowsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Generic ListFlowsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Associated Types

type Rep ListFlowsResponse :: Type -> Type #

NFData ListFlowsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

Methods

rnf :: ListFlowsResponse -> () #

type Rep ListFlowsResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.ListFlows

type Rep ListFlowsResponse = D1 ('MetaData "ListFlowsResponse" "Amazonka.MediaConnect.ListFlows" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "ListFlowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "flows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ListedFlow])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFlowsResponse Source #

Create a value of ListFlowsResponse 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:ListFlows', listFlowsResponse_nextToken - The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

$sel:flows:ListFlowsResponse', listFlowsResponse_flows - A list of flow summaries.

$sel:httpStatus:ListFlowsResponse', listFlowsResponse_httpStatus - The response's http status code.

Response Lenses

listFlowsResponse_nextToken :: Lens' ListFlowsResponse (Maybe Text) Source #

The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

listFlowsResponse_httpStatus :: Lens' ListFlowsResponse Int Source #

The response's http status code.