libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudTrail.GetInsightSelectors

Description

Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.

Synopsis

Creating a Request

data GetInsightSelectors Source #

See: newGetInsightSelectors smart constructor.

Constructors

GetInsightSelectors' 

Fields

  • trailName :: Text

    Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

    • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
    • Start with a letter or number, and end with a letter or number
    • Be between 3 and 128 characters
    • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
    • Not be in IP address format (for example, 192.168.5.4)

    If you specify a trail ARN, it must be in the format:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Instances

Instances details
Eq GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

(==) :: GetInsightSelectors -> GetInsightSelectors -> Bool #

(/=) :: GetInsightSelectors -> GetInsightSelectors -> Bool #

Read GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

readsPrec :: Int -> ReadS GetInsightSelectors #

readList :: ReadS [GetInsightSelectors] #

readPrec :: ReadPrec GetInsightSelectors #

readListPrec :: ReadPrec [GetInsightSelectors] #

Show GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

showsPrec :: Int -> GetInsightSelectors -> ShowS #

show :: GetInsightSelectors -> String #

showList :: [GetInsightSelectors] -> ShowS #

Generic GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Associated Types

type Rep GetInsightSelectors :: Type -> Type #

Methods

from :: GetInsightSelectors -> Rep GetInsightSelectors x #

to :: Rep GetInsightSelectors x -> GetInsightSelectors #

NFData GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

rnf :: GetInsightSelectors -> () #

Hashable GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

hashWithSalt :: Int -> GetInsightSelectors -> Int #

hash :: GetInsightSelectors -> Int #

ToJSON GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toJSON :: GetInsightSelectors -> Value #

toEncoding :: GetInsightSelectors -> Encoding #

toJSONList :: [GetInsightSelectors] -> Value #

toEncodingList :: [GetInsightSelectors] -> Encoding #

AWSRequest GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Associated Types

type AWSResponse GetInsightSelectors #

Methods

request :: GetInsightSelectors -> Request GetInsightSelectors #

response :: MonadResource m => Logger -> Service -> Proxy GetInsightSelectors -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetInsightSelectors))) #

ToHeaders GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toHeaders :: GetInsightSelectors -> [Header] #

ToPath GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toPath :: GetInsightSelectors -> ByteString #

ToQuery GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toQuery :: GetInsightSelectors -> QueryString #

type Rep GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

type Rep GetInsightSelectors = D1 ('MetaData "GetInsightSelectors" "Amazonka.CloudTrail.GetInsightSelectors" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "GetInsightSelectors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trailName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetInsightSelectors Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

type AWSResponse GetInsightSelectors = GetInsightSelectorsResponse

newGetInsightSelectors Source #

Arguments

:: Text

$sel:trailName:GetInsightSelectors'

-> GetInsightSelectors 

Create a value of GetInsightSelectors 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:trailName:GetInsightSelectors', getInsightSelectors_trailName - Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
  • Start with a letter or number, and end with a letter or number
  • Be between 3 and 128 characters
  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Request Lenses

getInsightSelectors_trailName :: Lens' GetInsightSelectors Text Source #

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
  • Start with a letter or number, and end with a letter or number
  • Be between 3 and 128 characters
  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Destructuring the Response

data GetInsightSelectorsResponse Source #

See: newGetInsightSelectorsResponse smart constructor.

Constructors

GetInsightSelectorsResponse' 

Fields

  • trailARN :: Maybe Text

    The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

  • insightSelectors :: Maybe [InsightSelector]

    A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetInsightSelectorsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

(==) :: GetInsightSelectorsResponse -> GetInsightSelectorsResponse -> Bool #

(/=) :: GetInsightSelectorsResponse -> GetInsightSelectorsResponse -> Bool #

Read GetInsightSelectorsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

readsPrec :: Int -> ReadS GetInsightSelectorsResponse #

readList :: ReadS [GetInsightSelectorsResponse] #

readPrec :: ReadPrec GetInsightSelectorsResponse #

readListPrec :: ReadPrec [GetInsightSelectorsResponse] #

Show GetInsightSelectorsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

showsPrec :: Int -> GetInsightSelectorsResponse -> ShowS #

show :: GetInsightSelectorsResponse -> String #

showList :: [GetInsightSelectorsResponse] -> ShowS #

Generic GetInsightSelectorsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Associated Types

type Rep GetInsightSelectorsResponse :: Type -> Type #

Methods

from :: GetInsightSelectorsResponse -> Rep GetInsightSelectorsResponse x #

to :: Rep GetInsightSelectorsResponse x -> GetInsightSelectorsResponse #

NFData GetInsightSelectorsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

rnf :: GetInsightSelectorsResponse -> () #

type Rep GetInsightSelectorsResponse Source # 
Instance details

Defined in Amazonka.CloudTrail.GetInsightSelectors

type Rep GetInsightSelectorsResponse = D1 ('MetaData "GetInsightSelectorsResponse" "Amazonka.CloudTrail.GetInsightSelectors" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "GetInsightSelectorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trailARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "insightSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InsightSelector])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetInsightSelectorsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetInsightSelectorsResponse'

-> GetInsightSelectorsResponse 

Create a value of GetInsightSelectorsResponse 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:trailARN:GetInsightSelectorsResponse', getInsightSelectorsResponse_trailARN - The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

$sel:insightSelectors:GetInsightSelectorsResponse', getInsightSelectorsResponse_insightSelectors - A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

$sel:httpStatus:GetInsightSelectorsResponse', getInsightSelectorsResponse_httpStatus - The response's http status code.

Response Lenses

getInsightSelectorsResponse_trailARN :: Lens' GetInsightSelectorsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

getInsightSelectorsResponse_insightSelectors :: Lens' GetInsightSelectorsResponse (Maybe [InsightSelector]) Source #

A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

getInsightSelectorsResponse_httpStatus :: Lens' GetInsightSelectorsResponse Int Source #

The response's http status code.