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.CloudWatchEvents.CreateArchive

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

Synopsis

data CreateArchive = CreateArchive' {
- description :: Maybe Text
- eventPattern :: Maybe Text
- retentionDays :: Maybe Natural
- archiveName :: Text
- eventSourceArn :: Text
}
newCreateArchive :: Text -> Text -> CreateArchive
createArchive_description :: Lens' CreateArchive (Maybe Text)
createArchive_eventPattern :: Lens' CreateArchive (Maybe Text)
createArchive_retentionDays :: Lens' CreateArchive (Maybe Natural)
createArchive_archiveName :: Lens' CreateArchive Text
createArchive_eventSourceArn :: Lens' CreateArchive Text
data CreateArchiveResponse = CreateArchiveResponse' {
- archiveArn :: Maybe Text
- creationTime :: Maybe POSIX
- state :: Maybe ArchiveState
- stateReason :: Maybe Text
- httpStatus :: Int
}
newCreateArchiveResponse :: Int -> CreateArchiveResponse
createArchiveResponse_archiveArn :: Lens' CreateArchiveResponse (Maybe Text)
createArchiveResponse_creationTime :: Lens' CreateArchiveResponse (Maybe UTCTime)
createArchiveResponse_state :: Lens' CreateArchiveResponse (Maybe ArchiveState)
createArchiveResponse_stateReason :: Lens' CreateArchiveResponse (Maybe Text)
createArchiveResponse_httpStatus :: Lens' CreateArchiveResponse Int

Creating a Request

data CreateArchive Source #

See: newCreateArchive smart constructor.

Constructors

CreateArchive'

Fields

description :: Maybe Text
A description for the archive.
eventPattern :: Maybe Text
An event pattern to use to filter events sent to the archive.
retentionDays :: Maybe Natural
The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
archiveName :: Text
The name for the archive to create.
eventSourceArn :: Text
The ARN of the event bus that sends events to the archive.

Instances

Instances details

ToJSON CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods toJSON :: CreateArchive -> Value # toEncoding :: CreateArchive -> Encoding # toJSONList :: [CreateArchive] -> Value # toEncodingList :: [CreateArchive] -> Encoding #
ToHeaders CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods toHeaders :: CreateArchive -> [Header] #
ToPath CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods toPath :: CreateArchive -> ByteString #
ToQuery CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods toQuery :: CreateArchive -> QueryString #
AWSRequest CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Associated Types type AWSResponse CreateArchive # Methods request :: (Service -> Service) -> CreateArchive -> Request CreateArchive # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateArchive -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateArchive))) #
Generic CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Associated Types type Rep CreateArchive :: Type -> Type # Methods from :: CreateArchive -> Rep CreateArchive x # to :: Rep CreateArchive x -> CreateArchive #
Read CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods readsPrec :: Int -> ReadS CreateArchive # readList :: ReadS [CreateArchive] # readPrec :: ReadPrec CreateArchive # readListPrec :: ReadPrec [CreateArchive] #
Show CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods showsPrec :: Int -> CreateArchive -> ShowS # show :: CreateArchive -> String # showList :: [CreateArchive] -> ShowS #
NFData CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods rnf :: CreateArchive -> () #
Eq CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods (==) :: CreateArchive -> CreateArchive -> Bool # (/=) :: CreateArchive -> CreateArchive -> Bool #
Hashable CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods hashWithSalt :: Int -> CreateArchive -> Int # hash :: CreateArchive -> Int #
type AWSResponse CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive type AWSResponse CreateArchive = CreateArchiveResponse
type Rep CreateArchive Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive type Rep CreateArchive = D1 ('MetaData "CreateArchive" "Amazonka.CloudWatchEvents.CreateArchive" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "CreateArchive'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "retentionDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "archiveName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateArchive Source #

Arguments

:: Text	`CreateArchive`
-> Text	`CreateArchive`
-> CreateArchive

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

CreateArchive, createArchive_description - A description for the archive.

CreateArchive, createArchive_eventPattern - An event pattern to use to filter events sent to the archive.

CreateArchive, createArchive_retentionDays - The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

CreateArchive, createArchive_archiveName - The name for the archive to create.

CreateArchive, createArchive_eventSourceArn - The ARN of the event bus that sends events to the archive.

Request Lenses

createArchive_description :: Lens' CreateArchive (Maybe Text) Source #

A description for the archive.

createArchive_eventPattern :: Lens' CreateArchive (Maybe Text) Source #

An event pattern to use to filter events sent to the archive.

createArchive_retentionDays :: Lens' CreateArchive (Maybe Natural) Source #

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

createArchive_archiveName :: Lens' CreateArchive Text Source #

The name for the archive to create.

createArchive_eventSourceArn :: Lens' CreateArchive Text Source #

The ARN of the event bus that sends events to the archive.

Destructuring the Response

data CreateArchiveResponse Source #

See: newCreateArchiveResponse smart constructor.

Constructors

CreateArchiveResponse'
Fields archiveArn :: Maybe Text The ARN of the archive that was created. creationTime :: Maybe POSIX The time at which the archive was created. state :: Maybe ArchiveState The state of the archive that was created. stateReason :: Maybe Text The reason that the archive is in the state. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Associated Types type Rep CreateArchiveResponse :: Type -> Type # Methods from :: CreateArchiveResponse -> Rep CreateArchiveResponse x # to :: Rep CreateArchiveResponse x -> CreateArchiveResponse #
Read CreateArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods readsPrec :: Int -> ReadS CreateArchiveResponse # readList :: ReadS [CreateArchiveResponse] # readPrec :: ReadPrec CreateArchiveResponse # readListPrec :: ReadPrec [CreateArchiveResponse] #
Show CreateArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods showsPrec :: Int -> CreateArchiveResponse -> ShowS # show :: CreateArchiveResponse -> String # showList :: [CreateArchiveResponse] -> ShowS #
NFData CreateArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods rnf :: CreateArchiveResponse -> () #
Eq CreateArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive Methods (==) :: CreateArchiveResponse -> CreateArchiveResponse -> Bool # (/=) :: CreateArchiveResponse -> CreateArchiveResponse -> Bool #
type Rep CreateArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateArchive type Rep CreateArchiveResponse = D1 ('MetaData "CreateArchiveResponse" "Amazonka.CloudWatchEvents.CreateArchive" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "CreateArchiveResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "archiveArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArchiveState)) :: (S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateArchiveResponse Source #

Arguments

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

Create a value of CreateArchiveResponse 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:archiveArn:CreateArchiveResponse', createArchiveResponse_archiveArn - The ARN of the archive that was created.

CreateArchiveResponse, createArchiveResponse_creationTime - The time at which the archive was created.

CreateArchiveResponse, createArchiveResponse_state - The state of the archive that was created.

CreateArchiveResponse, createArchiveResponse_stateReason - The reason that the archive is in the state.

$sel:httpStatus:CreateArchiveResponse', createArchiveResponse_httpStatus - The response's http status code.

Response Lenses

createArchiveResponse_archiveArn :: Lens' CreateArchiveResponse (Maybe Text) Source #

The ARN of the archive that was created.

createArchiveResponse_creationTime :: Lens' CreateArchiveResponse (Maybe UTCTime) Source #

The time at which the archive was created.

createArchiveResponse_state :: Lens' CreateArchiveResponse (Maybe ArchiveState) Source #

The state of the archive that was created.

createArchiveResponse_stateReason :: Lens' CreateArchiveResponse (Maybe Text) Source #

The reason that the archive is in the state.

createArchiveResponse_httpStatus :: Lens' CreateArchiveResponse Int Source #

The response's http status code.