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.Firehose.ListDeliveryStreams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists your delivery streams in alphabetical order of their names.

The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.

Synopsis

data ListDeliveryStreams = ListDeliveryStreams' {
}
newListDeliveryStreams :: ListDeliveryStreams
listDeliveryStreams_limit :: Lens' ListDeliveryStreams (Maybe Natural)
listDeliveryStreams_deliveryStreamType :: Lens' ListDeliveryStreams (Maybe DeliveryStreamType)
listDeliveryStreams_exclusiveStartDeliveryStreamName :: Lens' ListDeliveryStreams (Maybe Text)
data ListDeliveryStreamsResponse = ListDeliveryStreamsResponse' {
- httpStatus :: Int
- deliveryStreamNames :: [Text]
- hasMoreDeliveryStreams :: Bool
}
newListDeliveryStreamsResponse :: Int -> Bool -> ListDeliveryStreamsResponse
listDeliveryStreamsResponse_httpStatus :: Lens' ListDeliveryStreamsResponse Int
listDeliveryStreamsResponse_deliveryStreamNames :: Lens' ListDeliveryStreamsResponse [Text]
listDeliveryStreamsResponse_hasMoreDeliveryStreams :: Lens' ListDeliveryStreamsResponse Bool

Creating a Request

data ListDeliveryStreams Source #

See: newListDeliveryStreams smart constructor.

Constructors

ListDeliveryStreams'

Fields

limit :: Maybe Natural
The maximum number of delivery streams to list. The default value is 10.
deliveryStreamType :: Maybe DeliveryStreamType
The delivery stream type. This can be one of the following values:
- DirectPut: Provider applications access the delivery stream directly.
- KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
exclusiveStartDeliveryStreamName :: Maybe Text
The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

Instances

Instances details

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

newListDeliveryStreams :: ListDeliveryStreams Source #

Create a value of ListDeliveryStreams 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:limit:ListDeliveryStreams', listDeliveryStreams_limit - The maximum number of delivery streams to list. The default value is 10.

$sel:deliveryStreamType:ListDeliveryStreams', listDeliveryStreams_deliveryStreamType - The delivery stream type. This can be one of the following values:

DirectPut: Provider applications access the delivery stream directly.
KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

$sel:exclusiveStartDeliveryStreamName:ListDeliveryStreams', listDeliveryStreams_exclusiveStartDeliveryStreamName - The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

Request Lenses

listDeliveryStreams_limit :: Lens' ListDeliveryStreams (Maybe Natural) Source #

The maximum number of delivery streams to list. The default value is 10.

listDeliveryStreams_deliveryStreamType :: Lens' ListDeliveryStreams (Maybe DeliveryStreamType) Source #

The delivery stream type. This can be one of the following values:

DirectPut: Provider applications access the delivery stream directly.
KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

listDeliveryStreams_exclusiveStartDeliveryStreamName :: Lens' ListDeliveryStreams (Maybe Text) Source #

The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

Destructuring the Response

data ListDeliveryStreamsResponse Source #

See: newListDeliveryStreamsResponse smart constructor.

Constructors

ListDeliveryStreamsResponse'
Fields httpStatus :: Int The response's http status code. deliveryStreamNames :: [Text] The names of the delivery streams. hasMoreDeliveryStreams :: Bool Indicates whether there are more delivery streams available to list.

Instances

Instances details

Eq ListDeliveryStreamsResponse Source #
Instance details Defined in Amazonka.Firehose.ListDeliveryStreams Methods (==) :: ListDeliveryStreamsResponse -> ListDeliveryStreamsResponse -> Bool # (/=) :: ListDeliveryStreamsResponse -> ListDeliveryStreamsResponse -> Bool #
Read ListDeliveryStreamsResponse Source #
Instance details Defined in Amazonka.Firehose.ListDeliveryStreams Methods readsPrec :: Int -> ReadS ListDeliveryStreamsResponse # readList :: ReadS [ListDeliveryStreamsResponse] # readPrec :: ReadPrec ListDeliveryStreamsResponse # readListPrec :: ReadPrec [ListDeliveryStreamsResponse] #
Show ListDeliveryStreamsResponse Source #
Instance details Defined in Amazonka.Firehose.ListDeliveryStreams Methods showsPrec :: Int -> ListDeliveryStreamsResponse -> ShowS # show :: ListDeliveryStreamsResponse -> String # showList :: [ListDeliveryStreamsResponse] -> ShowS #
Generic ListDeliveryStreamsResponse Source #
Instance details Defined in Amazonka.Firehose.ListDeliveryStreams Associated Types type Rep ListDeliveryStreamsResponse :: Type -> Type # Methods from :: ListDeliveryStreamsResponse -> Rep ListDeliveryStreamsResponse x # to :: Rep ListDeliveryStreamsResponse x -> ListDeliveryStreamsResponse #
NFData ListDeliveryStreamsResponse Source #
Instance details Defined in Amazonka.Firehose.ListDeliveryStreams Methods rnf :: ListDeliveryStreamsResponse -> () #
type Rep ListDeliveryStreamsResponse Source #
Instance details Defined in Amazonka.Firehose.ListDeliveryStreams type Rep ListDeliveryStreamsResponse = D1 ('MetaData "ListDeliveryStreamsResponse" "Amazonka.Firehose.ListDeliveryStreams" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "ListDeliveryStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "deliveryStreamNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "hasMoreDeliveryStreams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newListDeliveryStreamsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDeliveryStreamsResponse'`
-> Bool	`$sel:hasMoreDeliveryStreams:ListDeliveryStreamsResponse'`
-> ListDeliveryStreamsResponse

Create a value of ListDeliveryStreamsResponse 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:httpStatus:ListDeliveryStreamsResponse', listDeliveryStreamsResponse_httpStatus - The response's http status code.

$sel:deliveryStreamNames:ListDeliveryStreamsResponse', listDeliveryStreamsResponse_deliveryStreamNames - The names of the delivery streams.

$sel:hasMoreDeliveryStreams:ListDeliveryStreamsResponse', listDeliveryStreamsResponse_hasMoreDeliveryStreams - Indicates whether there are more delivery streams available to list.

Response Lenses

listDeliveryStreamsResponse_httpStatus :: Lens' ListDeliveryStreamsResponse Int Source #

The response's http status code.

listDeliveryStreamsResponse_deliveryStreamNames :: Lens' ListDeliveryStreamsResponse [Text] Source #

The names of the delivery streams.

listDeliveryStreamsResponse_hasMoreDeliveryStreams :: Lens' ListDeliveryStreamsResponse Bool Source #

Indicates whether there are more delivery streams available to list.