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.DescribeArchive

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves details about an archive.

Synopsis

data DescribeArchive = DescribeArchive' {
- archiveName :: Text
}
newDescribeArchive :: Text -> DescribeArchive
describeArchive_archiveName :: Lens' DescribeArchive Text
data DescribeArchiveResponse = DescribeArchiveResponse' {
- archiveArn :: Maybe Text
- archiveName :: Maybe Text
- creationTime :: Maybe POSIX
- description :: Maybe Text
- eventCount :: Maybe Integer
- eventPattern :: Maybe Text
- eventSourceArn :: Maybe Text
- retentionDays :: Maybe Natural
- sizeBytes :: Maybe Integer
- state :: Maybe ArchiveState
- stateReason :: Maybe Text
- httpStatus :: Int
}
newDescribeArchiveResponse :: Int -> DescribeArchiveResponse
describeArchiveResponse_archiveArn :: Lens' DescribeArchiveResponse (Maybe Text)
describeArchiveResponse_archiveName :: Lens' DescribeArchiveResponse (Maybe Text)
describeArchiveResponse_creationTime :: Lens' DescribeArchiveResponse (Maybe UTCTime)
describeArchiveResponse_description :: Lens' DescribeArchiveResponse (Maybe Text)
describeArchiveResponse_eventCount :: Lens' DescribeArchiveResponse (Maybe Integer)
describeArchiveResponse_eventPattern :: Lens' DescribeArchiveResponse (Maybe Text)
describeArchiveResponse_eventSourceArn :: Lens' DescribeArchiveResponse (Maybe Text)
describeArchiveResponse_retentionDays :: Lens' DescribeArchiveResponse (Maybe Natural)
describeArchiveResponse_sizeBytes :: Lens' DescribeArchiveResponse (Maybe Integer)
describeArchiveResponse_state :: Lens' DescribeArchiveResponse (Maybe ArchiveState)
describeArchiveResponse_stateReason :: Lens' DescribeArchiveResponse (Maybe Text)
describeArchiveResponse_httpStatus :: Lens' DescribeArchiveResponse Int

Creating a Request

data DescribeArchive Source #

See: newDescribeArchive smart constructor.

Constructors

DescribeArchive'
Fields archiveName :: Text The name of the archive to retrieve.

Instances

Instances details

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

newDescribeArchive Source #

Arguments

:: Text	`DescribeArchive`
-> DescribeArchive

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

DescribeArchive, describeArchive_archiveName - The name of the archive to retrieve.

Request Lenses

describeArchive_archiveName :: Lens' DescribeArchive Text Source #

The name of the archive to retrieve.

Destructuring the Response

data DescribeArchiveResponse Source #

See: newDescribeArchiveResponse smart constructor.

Constructors

DescribeArchiveResponse'

Fields

archiveArn :: Maybe Text
The ARN of the archive.
archiveName :: Maybe Text
The name of the archive.
creationTime :: Maybe POSIX
The time at which the archive was created.
description :: Maybe Text
The description of the archive.
eventCount :: Maybe Integer
The number of events in the archive.
eventPattern :: Maybe Text
The event pattern used to filter events sent to the archive.
eventSourceArn :: Maybe Text
The ARN of the event source associated with the archive.
retentionDays :: Maybe Natural
The number of days to retain events for in the archive.
sizeBytes :: Maybe Integer
The size of the archive in bytes.
state :: Maybe ArchiveState
The state of the archive.
stateReason :: Maybe Text
The reason that the archive is in the state.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeArchive Associated Types type Rep DescribeArchiveResponse :: Type -> Type # Methods from :: DescribeArchiveResponse -> Rep DescribeArchiveResponse x # to :: Rep DescribeArchiveResponse x -> DescribeArchiveResponse #
Read DescribeArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeArchive Methods readsPrec :: Int -> ReadS DescribeArchiveResponse # readList :: ReadS [DescribeArchiveResponse] # readPrec :: ReadPrec DescribeArchiveResponse # readListPrec :: ReadPrec [DescribeArchiveResponse] #
Show DescribeArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeArchive Methods showsPrec :: Int -> DescribeArchiveResponse -> ShowS # show :: DescribeArchiveResponse -> String # showList :: [DescribeArchiveResponse] -> ShowS #
NFData DescribeArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeArchive Methods rnf :: DescribeArchiveResponse -> () #
Eq DescribeArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeArchive Methods (==) :: DescribeArchiveResponse -> DescribeArchiveResponse -> Bool # (/=) :: DescribeArchiveResponse -> DescribeArchiveResponse -> Bool #
type Rep DescribeArchiveResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeArchive type Rep DescribeArchiveResponse = D1 ('MetaData "DescribeArchiveResponse" "Amazonka.CloudWatchEvents.DescribeArchive" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeArchiveResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "archiveArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "archiveName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eventCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "retentionDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "sizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (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))))))

newDescribeArchiveResponse Source #

Arguments

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

Create a value of DescribeArchiveResponse 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:DescribeArchiveResponse', describeArchiveResponse_archiveArn - The ARN of the archive.

DescribeArchive, describeArchiveResponse_archiveName - The name of the archive.

DescribeArchiveResponse, describeArchiveResponse_creationTime - The time at which the archive was created.

DescribeArchiveResponse, describeArchiveResponse_description - The description of the archive.

DescribeArchiveResponse, describeArchiveResponse_eventCount - The number of events in the archive.

DescribeArchiveResponse, describeArchiveResponse_eventPattern - The event pattern used to filter events sent to the archive.

DescribeArchiveResponse, describeArchiveResponse_eventSourceArn - The ARN of the event source associated with the archive.

DescribeArchiveResponse, describeArchiveResponse_retentionDays - The number of days to retain events for in the archive.

DescribeArchiveResponse, describeArchiveResponse_sizeBytes - The size of the archive in bytes.

DescribeArchiveResponse, describeArchiveResponse_state - The state of the archive.

DescribeArchiveResponse, describeArchiveResponse_stateReason - The reason that the archive is in the state.

$sel:httpStatus:DescribeArchiveResponse', describeArchiveResponse_httpStatus - The response's http status code.

Response Lenses

describeArchiveResponse_archiveArn :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The ARN of the archive.

describeArchiveResponse_archiveName :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The name of the archive.

describeArchiveResponse_creationTime :: Lens' DescribeArchiveResponse (Maybe UTCTime) Source #

The time at which the archive was created.

describeArchiveResponse_description :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The description of the archive.

describeArchiveResponse_eventCount :: Lens' DescribeArchiveResponse (Maybe Integer) Source #

The number of events in the archive.

describeArchiveResponse_eventPattern :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The event pattern used to filter events sent to the archive.

describeArchiveResponse_eventSourceArn :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The ARN of the event source associated with the archive.

describeArchiveResponse_retentionDays :: Lens' DescribeArchiveResponse (Maybe Natural) Source #

The number of days to retain events for in the archive.

describeArchiveResponse_sizeBytes :: Lens' DescribeArchiveResponse (Maybe Integer) Source #

The size of the archive in bytes.

describeArchiveResponse_state :: Lens' DescribeArchiveResponse (Maybe ArchiveState) Source #

The state of the archive.

describeArchiveResponse_stateReason :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The reason that the archive is in the state.

describeArchiveResponse_httpStatus :: Lens' DescribeArchiveResponse Int Source #

The response's http status code.