Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pipes.ListPipes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

This operation returns paginated results.

Synopsis

data ListPipes = ListPipes' {
- currentState :: Maybe PipeState
- desiredState :: Maybe RequestedPipeState
- limit :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe (Sensitive Text)
- sourcePrefix :: Maybe Text
- targetPrefix :: Maybe Text
}
newListPipes :: ListPipes
listPipes_currentState :: Lens' ListPipes (Maybe PipeState)
listPipes_desiredState :: Lens' ListPipes (Maybe RequestedPipeState)
listPipes_limit :: Lens' ListPipes (Maybe Natural)
listPipes_namePrefix :: Lens' ListPipes (Maybe Text)
listPipes_nextToken :: Lens' ListPipes (Maybe Text)
listPipes_sourcePrefix :: Lens' ListPipes (Maybe Text)
listPipes_targetPrefix :: Lens' ListPipes (Maybe Text)
data ListPipesResponse = ListPipesResponse' {
- nextToken :: Maybe (Sensitive Text)
- pipes :: Maybe [Pipe]
- httpStatus :: Int
}
newListPipesResponse :: Int -> ListPipesResponse
listPipesResponse_nextToken :: Lens' ListPipesResponse (Maybe Text)
listPipesResponse_pipes :: Lens' ListPipesResponse (Maybe [Pipe])
listPipesResponse_httpStatus :: Lens' ListPipesResponse Int

Creating a Request

data ListPipes Source #

See: newListPipes smart constructor.

Constructors

ListPipes'

Fields

currentState :: Maybe PipeState
The state the pipe is in.
desiredState :: Maybe RequestedPipeState
The state the pipe should be in.
limit :: Maybe Natural
The maximum number of pipes to include in the response.
namePrefix :: Maybe Text
A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.
nextToken :: Maybe (Sensitive Text)
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.
sourcePrefix :: Maybe Text
The prefix matching the pipe source.
targetPrefix :: Maybe Text
The prefix matching the pipe target.

Instances

Instances details

ToHeaders ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods toHeaders :: ListPipes -> [Header] #
ToPath ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods toPath :: ListPipes -> ByteString #
ToQuery ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods toQuery :: ListPipes -> QueryString #
AWSPager ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods page :: ListPipes -> AWSResponse ListPipes -> Maybe ListPipes #
AWSRequest ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Associated Types type AWSResponse ListPipes # Methods request :: (Service -> Service) -> ListPipes -> Request ListPipes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPipes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPipes))) #
Generic ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Associated Types type Rep ListPipes :: Type -> Type # Methods from :: ListPipes -> Rep ListPipes x # to :: Rep ListPipes x -> ListPipes #
Show ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods showsPrec :: Int -> ListPipes -> ShowS # show :: ListPipes -> String # showList :: [ListPipes] -> ShowS #
NFData ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods rnf :: ListPipes -> () #
Eq ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods (==) :: ListPipes -> ListPipes -> Bool # (/=) :: ListPipes -> ListPipes -> Bool #
Hashable ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods hashWithSalt :: Int -> ListPipes -> Int # hash :: ListPipes -> Int #
type AWSResponse ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes type AWSResponse ListPipes = ListPipesResponse
type Rep ListPipes Source #
Instance details Defined in Amazonka.Pipes.ListPipes type Rep ListPipes = D1 ('MetaData "ListPipes" "Amazonka.Pipes.ListPipes" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "ListPipes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "currentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeState)) :: (S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestedPipeState)) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "sourcePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "targetPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListPipes :: ListPipes Source #

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

ListPipes, listPipes_currentState - The state the pipe is in.

ListPipes, listPipes_desiredState - The state the pipe should be in.

$sel:limit:ListPipes', listPipes_limit - The maximum number of pipes to include in the response.

$sel:namePrefix:ListPipes', listPipes_namePrefix - A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

ListPipes, listPipes_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.

$sel:sourcePrefix:ListPipes', listPipes_sourcePrefix - The prefix matching the pipe source.

$sel:targetPrefix:ListPipes', listPipes_targetPrefix - The prefix matching the pipe target.

Request Lenses

listPipes_currentState :: Lens' ListPipes (Maybe PipeState) Source #

The state the pipe is in.

listPipes_desiredState :: Lens' ListPipes (Maybe RequestedPipeState) Source #

The state the pipe should be in.

listPipes_limit :: Lens' ListPipes (Maybe Natural) Source #

The maximum number of pipes to include in the response.

listPipes_namePrefix :: Lens' ListPipes (Maybe Text) Source #

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

listPipes_nextToken :: Lens' ListPipes (Maybe Text) Source #

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.

listPipes_sourcePrefix :: Lens' ListPipes (Maybe Text) Source #

The prefix matching the pipe source.

listPipes_targetPrefix :: Lens' ListPipes (Maybe Text) Source #

The prefix matching the pipe target.

Destructuring the Response

data ListPipesResponse Source #

See: newListPipesResponse smart constructor.

Constructors

ListPipesResponse'

Fields

nextToken :: Maybe (Sensitive Text)
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.
pipes :: Maybe [Pipe]
The pipes returned by the call.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListPipesResponse Source #
Instance details Defined in Amazonka.Pipes.ListPipes Associated Types type Rep ListPipesResponse :: Type -> Type # Methods from :: ListPipesResponse -> Rep ListPipesResponse x # to :: Rep ListPipesResponse x -> ListPipesResponse #
Show ListPipesResponse Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods showsPrec :: Int -> ListPipesResponse -> ShowS # show :: ListPipesResponse -> String # showList :: [ListPipesResponse] -> ShowS #
NFData ListPipesResponse Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods rnf :: ListPipesResponse -> () #
Eq ListPipesResponse Source #
Instance details Defined in Amazonka.Pipes.ListPipes Methods (==) :: ListPipesResponse -> ListPipesResponse -> Bool # (/=) :: ListPipesResponse -> ListPipesResponse -> Bool #
type Rep ListPipesResponse Source #
Instance details Defined in Amazonka.Pipes.ListPipes type Rep ListPipesResponse = D1 ('MetaData "ListPipesResponse" "Amazonka.Pipes.ListPipes" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "ListPipesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "pipes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Pipe])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPipesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListPipesResponse'`
-> ListPipesResponse

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

ListPipes, listPipesResponse_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.

$sel:pipes:ListPipesResponse', listPipesResponse_pipes - The pipes returned by the call.

$sel:httpStatus:ListPipesResponse', listPipesResponse_httpStatus - The response's http status code.

Response Lenses

listPipesResponse_nextToken :: Lens' ListPipesResponse (Maybe Text) Source #

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.

listPipesResponse_pipes :: Lens' ListPipesResponse (Maybe [Pipe]) Source #

The pipes returned by the call.

listPipesResponse_httpStatus :: Lens' ListPipesResponse Int Source #

The response's http status code.