Amazonka.DynamoDB.DescribeContributorInsights

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

Creating a Request

data DescribeContributorInsights

See: newDescribeContributorInsights smart constructor.

Constructors

DescribeContributorInsights'

Fields

• indexName :: Maybe Text

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

• tableName :: Text

  The name of the table to describe.

Instances

ToJSON DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toJSON :: DescribeContributorInsights -> Value

toEncoding :: DescribeContributorInsights -> Encoding

toJSONList :: [DescribeContributorInsights] -> Value

toEncodingList :: [DescribeContributorInsights] -> Encoding

ToHeaders DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toHeaders :: DescribeContributorInsights -> [Header]

ToPath DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toPath :: DescribeContributorInsights -> ByteString

ToQuery DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

toQuery :: DescribeContributorInsights -> QueryString

AWSRequest DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Associated Types

type AWSResponse DescribeContributorInsights

Methods

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

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

Generic DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Associated Types

type Rep DescribeContributorInsights :: Type -> Type

Methods

from :: DescribeContributorInsights -> Rep DescribeContributorInsights x

to :: Rep DescribeContributorInsights x -> DescribeContributorInsights

Read DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

readsPrec :: Int -> ReadS DescribeContributorInsights

readList :: ReadS [DescribeContributorInsights]

readPrec :: ReadPrec DescribeContributorInsights

readListPrec :: ReadPrec [DescribeContributorInsights]

Show DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

showsPrec :: Int -> DescribeContributorInsights -> ShowS

show :: DescribeContributorInsights -> String

showList :: [DescribeContributorInsights] -> ShowS

NFData DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

rnf :: DescribeContributorInsights -> ()

Eq DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

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

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

Hashable DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

hashWithSalt :: Int -> DescribeContributorInsights -> Int

hash :: DescribeContributorInsights -> Int

type AWSResponse DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

type AWSResponse DescribeContributorInsights = DescribeContributorInsightsResponse

type Rep DescribeContributorInsights

Defined in Amazonka.DynamoDB.DescribeContributorInsights

type Rep DescribeContributorInsights = D1 ('MetaData "DescribeContributorInsights" "Amazonka.DynamoDB.DescribeContributorInsights" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" '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)))

newDescribeContributorInsights

Arguments

:: Text

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:

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

DescribeContributorInsights, describeContributorInsights_tableName - The name of the table to describe.

Request Lenses

describeContributorInsights_indexName :: Lens' DescribeContributorInsights (Maybe Text)

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

describeContributorInsights_tableName :: Lens' DescribeContributorInsights Text

The name of the table to describe.

Destructuring the Response

data DescribeContributorInsightsResponse

See: newDescribeContributorInsightsResponse smart constructor.

Constructors

DescribeContributorInsightsResponse'

Fields

• contributorInsightsRuleList :: Maybe [Text]

  List of names of the associated contributor insights rules.

• contributorInsightsStatus :: Maybe ContributorInsightsStatus

  Current status of contributor insights.

• failureException :: Maybe FailureException

  Returns information about the last failure that was 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.
• indexName :: Maybe Text

  The name of the global secondary index being described.

• lastUpdateDateTime :: Maybe POSIX

  Timestamp of the last time the status was changed.

• tableName :: Maybe Text

  The name of the table being described.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeContributorInsightsResponse

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Associated Types

type Rep DescribeContributorInsightsResponse :: Type -> Type

Methods

from :: DescribeContributorInsightsResponse -> Rep DescribeContributorInsightsResponse x

to :: Rep DescribeContributorInsightsResponse x -> DescribeContributorInsightsResponse

Read DescribeContributorInsightsResponse

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

readsPrec :: Int -> ReadS DescribeContributorInsightsResponse

readList :: ReadS [DescribeContributorInsightsResponse]

readPrec :: ReadPrec DescribeContributorInsightsResponse

readListPrec :: ReadPrec [DescribeContributorInsightsResponse]

Show DescribeContributorInsightsResponse

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

showsPrec :: Int -> DescribeContributorInsightsResponse -> ShowS

show :: DescribeContributorInsightsResponse -> String

showList :: [DescribeContributorInsightsResponse] -> ShowS

NFData DescribeContributorInsightsResponse

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

rnf :: DescribeContributorInsightsResponse -> ()

Eq DescribeContributorInsightsResponse

Defined in Amazonka.DynamoDB.DescribeContributorInsights

Methods

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

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

type Rep DescribeContributorInsightsResponse

Defined in Amazonka.DynamoDB.DescribeContributorInsights

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

newDescribeContributorInsightsResponse

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 contributor insights rules.

DescribeContributorInsightsResponse, describeContributorInsightsResponse_contributorInsightsStatus - Current status of contributor insights.

$sel:failureException:DescribeContributorInsightsResponse', describeContributorInsightsResponse_failureException - Returns information about the last failure that was 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.

DescribeContributorInsights, describeContributorInsightsResponse_indexName - The name of the global secondary index being described.

DescribeContributorInsightsResponse, describeContributorInsightsResponse_lastUpdateDateTime - Timestamp of the last time the status was changed.

DescribeContributorInsights, describeContributorInsightsResponse_tableName - The name of the table being described.

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

Response Lenses

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

List of names of the associated contributor insights rules.

describeContributorInsightsResponse_contributorInsightsStatus :: Lens' DescribeContributorInsightsResponse (Maybe ContributorInsightsStatus)

Current status of contributor insights.

describeContributorInsightsResponse_failureException :: Lens' DescribeContributorInsightsResponse (Maybe FailureException)

Returns information about the last failure that was 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_indexName :: Lens' DescribeContributorInsightsResponse (Maybe Text)

The name of the global secondary index being described.

describeContributorInsightsResponse_lastUpdateDateTime :: Lens' DescribeContributorInsightsResponse (Maybe UTCTime)

Timestamp of the last time the status was changed.

describeContributorInsightsResponse_tableName :: Lens' DescribeContributorInsightsResponse (Maybe Text)

The name of the table being described.

describeContributorInsightsResponse_httpStatus :: Lens' DescribeContributorInsightsResponse Int

The response's http status code.