amazonka-cloudtrail-2.0: Amazon CloudTrail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudTrail.ListPublicKeys

Description

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPublicKeys Source #

Requests the public keys for a specified time range.

See: newListPublicKeys smart constructor.

Constructors

ListPublicKeys' 

Fields

  • endTime :: Maybe POSIX

    Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

  • nextToken :: Maybe Text

    Reserved for future use.

  • startTime :: Maybe POSIX

    Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

Instances

Instances details
ToJSON ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

ToHeaders ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

ToPath ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

ToQuery ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

AWSPager ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

AWSRequest ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Associated Types

type AWSResponse ListPublicKeys #

Generic ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Associated Types

type Rep ListPublicKeys :: Type -> Type #

Read ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Show ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

NFData ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Methods

rnf :: ListPublicKeys -> () #

Eq ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Hashable ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

type AWSResponse ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

type Rep ListPublicKeys Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

type Rep ListPublicKeys = D1 ('MetaData "ListPublicKeys" "Amazonka.CloudTrail.ListPublicKeys" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListPublicKeys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newListPublicKeys :: ListPublicKeys Source #

Create a value of ListPublicKeys 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:endTime:ListPublicKeys', listPublicKeys_endTime - Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

ListPublicKeys, listPublicKeys_nextToken - Reserved for future use.

$sel:startTime:ListPublicKeys', listPublicKeys_startTime - Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

Request Lenses

listPublicKeys_endTime :: Lens' ListPublicKeys (Maybe UTCTime) Source #

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

listPublicKeys_startTime :: Lens' ListPublicKeys (Maybe UTCTime) Source #

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

Destructuring the Response

data ListPublicKeysResponse Source #

Returns the objects or data listed below if successful. Otherwise, returns an error.

See: newListPublicKeysResponse smart constructor.

Constructors

ListPublicKeysResponse' 

Fields

Instances

Instances details
Generic ListPublicKeysResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Associated Types

type Rep ListPublicKeysResponse :: Type -> Type #

Read ListPublicKeysResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Show ListPublicKeysResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

NFData ListPublicKeysResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

Methods

rnf :: ListPublicKeysResponse -> () #

Eq ListPublicKeysResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

type Rep ListPublicKeysResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.ListPublicKeys

type Rep ListPublicKeysResponse = D1 ('MetaData "ListPublicKeysResponse" "Amazonka.CloudTrail.ListPublicKeys" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListPublicKeysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publicKeyList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PublicKey])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPublicKeysResponse Source #

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

ListPublicKeys, listPublicKeysResponse_nextToken - Reserved for future use.

$sel:publicKeyList:ListPublicKeysResponse', listPublicKeysResponse_publicKeyList - Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.

$sel:httpStatus:ListPublicKeysResponse', listPublicKeysResponse_httpStatus - The response's http status code.

Response Lenses

listPublicKeysResponse_publicKeyList :: Lens' ListPublicKeysResponse (Maybe [PublicKey]) Source #

Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.