Amazonka.CloudWatchEvents.CreateArchive

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.

Creating a Request

data CreateArchive

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

ToJSON CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

toJSON :: CreateArchive -> Value

toEncoding :: CreateArchive -> Encoding

toJSONList :: [CreateArchive] -> Value

toEncodingList :: [CreateArchive] -> Encoding

ToHeaders CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

toHeaders :: CreateArchive -> [Header]

ToPath CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

toPath :: CreateArchive -> ByteString

ToQuery CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

toQuery :: CreateArchive -> QueryString

AWSRequest CreateArchive

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

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

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

readsPrec :: Int -> ReadS CreateArchive

readList :: ReadS [CreateArchive]

readPrec :: ReadPrec CreateArchive

readListPrec :: ReadPrec [CreateArchive]

Show CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

showsPrec :: Int -> CreateArchive -> ShowS

show :: CreateArchive -> String

showList :: [CreateArchive] -> ShowS

NFData CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

rnf :: CreateArchive -> ()

Eq CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

(==) :: CreateArchive -> CreateArchive -> Bool

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

Hashable CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

hashWithSalt :: Int -> CreateArchive -> Int

hash :: CreateArchive -> Int

type AWSResponse CreateArchive

Defined in Amazonka.CloudWatchEvents.CreateArchive

type AWSResponse CreateArchive = CreateArchiveResponse

type Rep CreateArchive

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

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)

A description for the archive.

createArchive_eventPattern :: Lens' CreateArchive (Maybe Text)

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

createArchive_retentionDays :: Lens' CreateArchive (Maybe Natural)

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

The name for the archive to create.

createArchive_eventSourceArn :: Lens' CreateArchive Text

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

Destructuring the Response

data CreateArchiveResponse

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

Generic CreateArchiveResponse

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

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

readsPrec :: Int -> ReadS CreateArchiveResponse

readList :: ReadS [CreateArchiveResponse]

readPrec :: ReadPrec CreateArchiveResponse

readListPrec :: ReadPrec [CreateArchiveResponse]

Show CreateArchiveResponse

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

showsPrec :: Int -> CreateArchiveResponse -> ShowS

show :: CreateArchiveResponse -> String

showList :: [CreateArchiveResponse] -> ShowS

NFData CreateArchiveResponse

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

rnf :: CreateArchiveResponse -> ()

Eq CreateArchiveResponse

Defined in Amazonka.CloudWatchEvents.CreateArchive

Methods

(==) :: CreateArchiveResponse -> CreateArchiveResponse -> Bool

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

type Rep CreateArchiveResponse

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

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)

The ARN of the archive that was created.

createArchiveResponse_creationTime :: Lens' CreateArchiveResponse (Maybe UTCTime)

The time at which the archive was created.

createArchiveResponse_state :: Lens' CreateArchiveResponse (Maybe ArchiveState)

The state of the archive that was created.

createArchiveResponse_stateReason :: Lens' CreateArchiveResponse (Maybe Text)

The reason that the archive is in the state.

createArchiveResponse_httpStatus :: Lens' CreateArchiveResponse Int

The response's http status code.