Amazonka.CloudTrail.GetInsightSelectors

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.

Creating a Request

data GetInsightSelectors

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

ToJSON GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toJSON :: GetInsightSelectors -> Value

toEncoding :: GetInsightSelectors -> Encoding

toJSONList :: [GetInsightSelectors] -> Value

toEncodingList :: [GetInsightSelectors] -> Encoding

ToHeaders GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toHeaders :: GetInsightSelectors -> [Header]

ToPath GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toPath :: GetInsightSelectors -> ByteString

ToQuery GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

toQuery :: GetInsightSelectors -> QueryString

AWSRequest GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Associated Types

type AWSResponse GetInsightSelectors

Methods

request :: (Service -> Service) -> GetInsightSelectors -> Request GetInsightSelectors

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

Generic GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Associated Types

type Rep GetInsightSelectors :: Type -> Type

Methods

from :: GetInsightSelectors -> Rep GetInsightSelectors x

to :: Rep GetInsightSelectors x -> GetInsightSelectors

Read GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

readsPrec :: Int -> ReadS GetInsightSelectors

readList :: ReadS [GetInsightSelectors]

readPrec :: ReadPrec GetInsightSelectors

readListPrec :: ReadPrec [GetInsightSelectors]

Show GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

showsPrec :: Int -> GetInsightSelectors -> ShowS

show :: GetInsightSelectors -> String

showList :: [GetInsightSelectors] -> ShowS

NFData GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

rnf :: GetInsightSelectors -> ()

Eq GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

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

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

Hashable GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

hashWithSalt :: Int -> GetInsightSelectors -> Int

hash :: GetInsightSelectors -> Int

type AWSResponse GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

type AWSResponse GetInsightSelectors = GetInsightSelectorsResponse

type Rep GetInsightSelectors

Defined in Amazonka.CloudTrail.GetInsightSelectors

type Rep GetInsightSelectors = D1 ('MetaData "GetInsightSelectors" "Amazonka.CloudTrail.GetInsightSelectors" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "GetInsightSelectors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trailName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetInsightSelectors

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

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

See: newGetInsightSelectorsResponse smart constructor.

Constructors

GetInsightSelectorsResponse'

Fields

• insightSelectors :: Maybe [InsightSelector]

  A JSON string that contains the insight types you want to log on a trail. In this release, ApiErrorRateInsight and ApiCallRateInsight are supported as insight types.

• trailARN :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetInsightSelectorsResponse

Defined in Amazonka.CloudTrail.GetInsightSelectors

Associated Types

type Rep GetInsightSelectorsResponse :: Type -> Type

Methods

from :: GetInsightSelectorsResponse -> Rep GetInsightSelectorsResponse x

to :: Rep GetInsightSelectorsResponse x -> GetInsightSelectorsResponse

Read GetInsightSelectorsResponse

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

readsPrec :: Int -> ReadS GetInsightSelectorsResponse

readList :: ReadS [GetInsightSelectorsResponse]

readPrec :: ReadPrec GetInsightSelectorsResponse

readListPrec :: ReadPrec [GetInsightSelectorsResponse]

Show GetInsightSelectorsResponse

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

showsPrec :: Int -> GetInsightSelectorsResponse -> ShowS

show :: GetInsightSelectorsResponse -> String

showList :: [GetInsightSelectorsResponse] -> ShowS

NFData GetInsightSelectorsResponse

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

rnf :: GetInsightSelectorsResponse -> ()

Eq GetInsightSelectorsResponse

Defined in Amazonka.CloudTrail.GetInsightSelectors

Methods

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

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

type Rep GetInsightSelectorsResponse

Defined in Amazonka.CloudTrail.GetInsightSelectors

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

newGetInsightSelectorsResponse

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:insightSelectors:GetInsightSelectorsResponse', getInsightSelectorsResponse_insightSelectors - A JSON string that contains the insight types you want to log on a trail. In this release, ApiErrorRateInsight and ApiCallRateInsight are supported as insight types.

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

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

Response Lenses

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

A JSON string that contains the insight types you want to log on a trail. In this release, ApiErrorRateInsight and ApiCallRateInsight are supported as insight types.

getInsightSelectorsResponse_trailARN :: Lens' GetInsightSelectorsResponse (Maybe Text)

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

getInsightSelectorsResponse_httpStatus :: Lens' GetInsightSelectorsResponse Int

The response's http status code.