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.CloudTrail.GetEventDataStore

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Synopsis

Creating a Request

data GetEventDataStore Source #

See: newGetEventDataStore smart constructor.

Constructors

GetEventDataStore'
Fields eventDataStore :: Text The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Instances

Instances details

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

newGetEventDataStore Source #

Arguments

:: Text	`$sel:eventDataStore:GetEventDataStore'`
-> GetEventDataStore

Create a value of GetEventDataStore 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:eventDataStore:GetEventDataStore', getEventDataStore_eventDataStore - The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Request Lenses

getEventDataStore_eventDataStore :: Lens' GetEventDataStore Text Source #

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Destructuring the Response

data GetEventDataStoreResponse Source #

See: newGetEventDataStoreResponse smart constructor.

Constructors

GetEventDataStoreResponse'

Fields

advancedEventSelectors :: Maybe [AdvancedEventSelector]
The advanced event selectors used to select events for the data store.
createdTimestamp :: Maybe POSIX
The timestamp of the event data store's creation.
eventDataStoreArn :: Maybe Text
The event data store Amazon Resource Number (ARN).
kmsKeyId :: Maybe Text
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
```
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
```
multiRegionEnabled :: Maybe Bool
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
name :: Maybe Text
The name of the event data store.
organizationEnabled :: Maybe Bool
Indicates whether an event data store is collecting logged events for an organization in Organizations.
retentionPeriod :: Maybe Natural
The retention period of the event data store, in days.
status :: Maybe EventDataStoreStatus
The status of an event data store. Values can be ENABLED and PENDING_DELETION.
terminationProtectionEnabled :: Maybe Bool
Indicates that termination protection is enabled.
updatedTimestamp :: Maybe POSIX
Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetEventDataStore Associated Types type Rep GetEventDataStoreResponse :: Type -> Type # Methods from :: GetEventDataStoreResponse -> Rep GetEventDataStoreResponse x # to :: Rep GetEventDataStoreResponse x -> GetEventDataStoreResponse #
Read GetEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetEventDataStore Methods readsPrec :: Int -> ReadS GetEventDataStoreResponse # readList :: ReadS [GetEventDataStoreResponse] # readPrec :: ReadPrec GetEventDataStoreResponse # readListPrec :: ReadPrec [GetEventDataStoreResponse] #
Show GetEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetEventDataStore Methods showsPrec :: Int -> GetEventDataStoreResponse -> ShowS # show :: GetEventDataStoreResponse -> String # showList :: [GetEventDataStoreResponse] -> ShowS #
NFData GetEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetEventDataStore Methods rnf :: GetEventDataStoreResponse -> () #
Eq GetEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetEventDataStore Methods (==) :: GetEventDataStoreResponse -> GetEventDataStoreResponse -> Bool # (/=) :: GetEventDataStoreResponse -> GetEventDataStoreResponse -> Bool #
type Rep GetEventDataStoreResponse Source #
Instance details Defined in Amazonka.CloudTrail.GetEventDataStore type Rep GetEventDataStoreResponse = D1 ('MetaData "GetEventDataStoreResponse" "Amazonka.CloudTrail.GetEventDataStore" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "GetEventDataStoreResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "advancedEventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedEventSelector])) :: (S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "eventDataStoreArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "multiRegionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "organizationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventDataStoreStatus)))) :: (S1 ('MetaSel ('Just "terminationProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "updatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetEventDataStoreResponse Source #

Arguments

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

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

GetEventDataStoreResponse, getEventDataStoreResponse_advancedEventSelectors - The advanced event selectors used to select events for the data store.

GetEventDataStoreResponse, getEventDataStoreResponse_createdTimestamp - The timestamp of the event data store's creation.

GetEventDataStoreResponse, getEventDataStoreResponse_eventDataStoreArn - The event data store Amazon Resource Number (ARN).

GetEventDataStoreResponse, getEventDataStoreResponse_kmsKeyId - Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

GetEventDataStoreResponse, getEventDataStoreResponse_multiRegionEnabled - Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

GetEventDataStoreResponse, getEventDataStoreResponse_name - The name of the event data store.

GetEventDataStoreResponse, getEventDataStoreResponse_organizationEnabled - Indicates whether an event data store is collecting logged events for an organization in Organizations.

GetEventDataStoreResponse, getEventDataStoreResponse_retentionPeriod - The retention period of the event data store, in days.

GetEventDataStoreResponse, getEventDataStoreResponse_status - The status of an event data store. Values can be ENABLED and PENDING_DELETION.

GetEventDataStoreResponse, getEventDataStoreResponse_terminationProtectionEnabled - Indicates that termination protection is enabled.

GetEventDataStoreResponse, getEventDataStoreResponse_updatedTimestamp - Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

$sel:httpStatus:GetEventDataStoreResponse', getEventDataStoreResponse_httpStatus - The response's http status code.

Response Lenses

getEventDataStoreResponse_advancedEventSelectors :: Lens' GetEventDataStoreResponse (Maybe [AdvancedEventSelector]) Source #

The advanced event selectors used to select events for the data store.

getEventDataStoreResponse_createdTimestamp :: Lens' GetEventDataStoreResponse (Maybe UTCTime) Source #

The timestamp of the event data store's creation.

getEventDataStoreResponse_eventDataStoreArn :: Lens' GetEventDataStoreResponse (Maybe Text) Source #

The event data store Amazon Resource Number (ARN).

getEventDataStoreResponse_kmsKeyId :: Lens' GetEventDataStoreResponse (Maybe Text) Source #

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

getEventDataStoreResponse_multiRegionEnabled :: Lens' GetEventDataStoreResponse (Maybe Bool) Source #

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

getEventDataStoreResponse_name :: Lens' GetEventDataStoreResponse (Maybe Text) Source #

The name of the event data store.

getEventDataStoreResponse_organizationEnabled :: Lens' GetEventDataStoreResponse (Maybe Bool) Source #

Indicates whether an event data store is collecting logged events for an organization in Organizations.

getEventDataStoreResponse_retentionPeriod :: Lens' GetEventDataStoreResponse (Maybe Natural) Source #

The retention period of the event data store, in days.

getEventDataStoreResponse_status :: Lens' GetEventDataStoreResponse (Maybe EventDataStoreStatus) Source #

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

getEventDataStoreResponse_terminationProtectionEnabled :: Lens' GetEventDataStoreResponse (Maybe Bool) Source #

Indicates that termination protection is enabled.

getEventDataStoreResponse_updatedTimestamp :: Lens' GetEventDataStoreResponse (Maybe UTCTime) Source #

Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

getEventDataStoreResponse_httpStatus :: Lens' GetEventDataStoreResponse Int Source #

The response's http status code.