libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb
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.DynamoDB.DescribeContributorInsights

Description

Returns information about contributor insights, for a given table or global secondary index.

Synopsis

Creating a Request

data DescribeContributorInsights Source #

See: newDescribeContributorInsights smart constructor.

Constructors

DescribeContributorInsights' 

Fields

Instances

Instances details
Eq DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

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

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

Read DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

readsPrec :: Int -> ReadS DescribeContributorInsights #

readList :: ReadS [DescribeContributorInsights] #

readPrec :: ReadPrec DescribeContributorInsights #

readListPrec :: ReadPrec [DescribeContributorInsights] #

Show DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

showsPrec :: Int -> DescribeContributorInsights -> ShowS #

show :: DescribeContributorInsights -> String #

showList :: [DescribeContributorInsights] -> ShowS #

Generic DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Associated Types

type Rep DescribeContributorInsights :: Type -> Type #

Methods

from :: DescribeContributorInsights -> Rep DescribeContributorInsights x #

to :: Rep DescribeContributorInsights x -> DescribeContributorInsights #

NFData DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

rnf :: DescribeContributorInsights -> () #

Hashable DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

hashWithSalt :: Int -> DescribeContributorInsights -> Int #

hash :: DescribeContributorInsights -> Int #

ToJSON DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toJSON :: DescribeContributorInsights -> Value #

toEncoding :: DescribeContributorInsights -> Encoding #

toJSONList :: [DescribeContributorInsights] -> Value #

toEncodingList :: [DescribeContributorInsights] -> Encoding #

AWSRequest DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Associated Types

type AWSResponse DescribeContributorInsights #

Methods

request :: DescribeContributorInsights -> Request DescribeContributorInsights #

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

ToHeaders DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toHeaders :: DescribeContributorInsights -> [Header] #

ToPath DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toPath :: DescribeContributorInsights -> ByteString #

ToQuery DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toQuery :: DescribeContributorInsights -> QueryString #

type Rep DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

type Rep DescribeContributorInsights = D1 ('MetaData "DescribeContributorInsights" "Amazonka.DynamoDB.DescribeContributorInsights" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "DescribeContributorInsights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeContributorInsights Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

type AWSResponse DescribeContributorInsights = DescribeContributorInsightsResponse

newDescribeContributorInsights Source #

Arguments

:: Text

$sel:tableName:DescribeContributorInsights'

-> DescribeContributorInsights 

Create a value of DescribeContributorInsights 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:indexName:DescribeContributorInsights', describeContributorInsights_indexName - The name of the global secondary index to describe, if applicable.

$sel:tableName:DescribeContributorInsights', describeContributorInsights_tableName - The name of the table to describe.

Request Lenses

describeContributorInsights_indexName :: Lens' DescribeContributorInsights (Maybe Text) Source #

The name of the global secondary index to describe, if applicable.

describeContributorInsights_tableName :: Lens' DescribeContributorInsights Text Source #

The name of the table to describe.

Destructuring the Response

data DescribeContributorInsightsResponse Source #

See: newDescribeContributorInsightsResponse smart constructor.

Constructors

DescribeContributorInsightsResponse' 

Fields

  • contributorInsightsRuleList :: Maybe [Text]

    List of names of the associated Alpine rules.

  • failureException :: Maybe FailureException

    Returns information about the last failure that encountered.

    The most common exceptions for a FAILED status are:

    • LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
    • AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
    • AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
    • InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
  • contributorInsightsStatus :: Maybe ContributorInsightsStatus

    Current Status contributor insights.

  • lastUpdateDateTime :: Maybe POSIX

    Timestamp of the last time the status was changed.

  • tableName :: Maybe Text

    The name of the table being described.

  • indexName :: Maybe Text

    The name of the global secondary index being described.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeContributorInsightsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

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

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

Read DescribeContributorInsightsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

readsPrec :: Int -> ReadS DescribeContributorInsightsResponse #

readList :: ReadS [DescribeContributorInsightsResponse] #

readPrec :: ReadPrec DescribeContributorInsightsResponse #

readListPrec :: ReadPrec [DescribeContributorInsightsResponse] #

Show DescribeContributorInsightsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

showsPrec :: Int -> DescribeContributorInsightsResponse -> ShowS #

show :: DescribeContributorInsightsResponse -> String #

showList :: [DescribeContributorInsightsResponse] -> ShowS #

Generic DescribeContributorInsightsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Associated Types

type Rep DescribeContributorInsightsResponse :: Type -> Type #

Methods

from :: DescribeContributorInsightsResponse -> Rep DescribeContributorInsightsResponse x #

to :: Rep DescribeContributorInsightsResponse x -> DescribeContributorInsightsResponse #

NFData DescribeContributorInsightsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

rnf :: DescribeContributorInsightsResponse -> () #

type Rep DescribeContributorInsightsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeContributorInsights

type Rep DescribeContributorInsightsResponse = D1 ('MetaData "DescribeContributorInsightsResponse" "Amazonka.DynamoDB.DescribeContributorInsights" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "DescribeContributorInsightsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contributorInsightsRuleList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "failureException") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureException)) :*: S1 ('MetaSel ('Just "contributorInsightsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContributorInsightsStatus)))) :*: ((S1 ('MetaSel ('Just "lastUpdateDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeContributorInsightsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeContributorInsightsResponse'

-> DescribeContributorInsightsResponse 

Create a value of DescribeContributorInsightsResponse 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:contributorInsightsRuleList:DescribeContributorInsightsResponse', describeContributorInsightsResponse_contributorInsightsRuleList - List of names of the associated Alpine rules.

$sel:failureException:DescribeContributorInsightsResponse', describeContributorInsightsResponse_failureException - Returns information about the last failure that encountered.

The most common exceptions for a FAILED status are:

  • LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
  • AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
  • AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
  • InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.

$sel:contributorInsightsStatus:DescribeContributorInsightsResponse', describeContributorInsightsResponse_contributorInsightsStatus - Current Status contributor insights.

$sel:lastUpdateDateTime:DescribeContributorInsightsResponse', describeContributorInsightsResponse_lastUpdateDateTime - Timestamp of the last time the status was changed.

$sel:tableName:DescribeContributorInsights', describeContributorInsightsResponse_tableName - The name of the table being described.

$sel:indexName:DescribeContributorInsights', describeContributorInsightsResponse_indexName - The name of the global secondary index being described.

$sel:httpStatus:DescribeContributorInsightsResponse', describeContributorInsightsResponse_httpStatus - The response's http status code.

Response Lenses

describeContributorInsightsResponse_contributorInsightsRuleList :: Lens' DescribeContributorInsightsResponse (Maybe [Text]) Source #

List of names of the associated Alpine rules.

describeContributorInsightsResponse_failureException :: Lens' DescribeContributorInsightsResponse (Maybe FailureException) Source #

Returns information about the last failure that encountered.

The most common exceptions for a FAILED status are:

  • LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
  • AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
  • AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
  • InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.

describeContributorInsightsResponse_contributorInsightsStatus :: Lens' DescribeContributorInsightsResponse (Maybe ContributorInsightsStatus) Source #

Current Status contributor insights.

describeContributorInsightsResponse_lastUpdateDateTime :: Lens' DescribeContributorInsightsResponse (Maybe UTCTime) Source #

Timestamp of the last time the status was changed.

describeContributorInsightsResponse_tableName :: Lens' DescribeContributorInsightsResponse (Maybe Text) Source #

The name of the table being described.

describeContributorInsightsResponse_indexName :: Lens' DescribeContributorInsightsResponse (Maybe Text) Source #

The name of the global secondary index being described.

describeContributorInsightsResponse_httpStatus :: Lens' DescribeContributorInsightsResponse Int Source #

The response's http status code.