Amazonka.Pipes.ListPipes

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.

Creating a Request

data ListPipes

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

ToHeaders ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

toHeaders :: ListPipes -> [Header]

ToPath ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

toPath :: ListPipes -> ByteString

ToQuery ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

toQuery :: ListPipes -> QueryString

AWSPager ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

page :: ListPipes -> AWSResponse ListPipes -> Maybe ListPipes

AWSRequest ListPipes

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

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

Defined in Amazonka.Pipes.ListPipes

Methods

showsPrec :: Int -> ListPipes -> ShowS

show :: ListPipes -> String

showList :: [ListPipes] -> ShowS

NFData ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

rnf :: ListPipes -> ()

Eq ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

(==) :: ListPipes -> ListPipes -> Bool

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

Hashable ListPipes

Defined in Amazonka.Pipes.ListPipes

Methods

hashWithSalt :: Int -> ListPipes -> Int

hash :: ListPipes -> Int

type AWSResponse ListPipes

Defined in Amazonka.Pipes.ListPipes

type AWSResponse ListPipes = ListPipesResponse

type Rep ListPipes

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

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)

The state the pipe is in.

listPipes_desiredState :: Lens' ListPipes (Maybe RequestedPipeState)

The state the pipe should be in.

listPipes_limit :: Lens' ListPipes (Maybe Natural)

The maximum number of pipes to include in the response.

listPipes_namePrefix :: Lens' ListPipes (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.

listPipes_nextToken :: Lens' ListPipes (Maybe 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.

listPipes_sourcePrefix :: Lens' ListPipes (Maybe Text)

The prefix matching the pipe source.

listPipes_targetPrefix :: Lens' ListPipes (Maybe Text)

The prefix matching the pipe target.

Destructuring the Response

data ListPipesResponse

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

Generic ListPipesResponse

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

Defined in Amazonka.Pipes.ListPipes

Methods

showsPrec :: Int -> ListPipesResponse -> ShowS

show :: ListPipesResponse -> String

showList :: [ListPipesResponse] -> ShowS

NFData ListPipesResponse

Defined in Amazonka.Pipes.ListPipes

Methods

rnf :: ListPipesResponse -> ()

Eq ListPipesResponse

Defined in Amazonka.Pipes.ListPipes

Methods

(==) :: ListPipesResponse -> ListPipesResponse -> Bool

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

type Rep ListPipesResponse

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

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)

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])

The pipes returned by the call.

listPipesResponse_httpStatus :: Lens' ListPipesResponse Int

The response's http status code.