amazonka-personalize-2.0: Amazon Personalize 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.Personalize.CreateMetricAttribution

Description

Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

Synopsis

Creating a Request

data CreateMetricAttribution Source #

See: newCreateMetricAttribution smart constructor.

Constructors

CreateMetricAttribution' 

Fields

  • name :: Text

    A name for the metric attribution.

  • datasetGroupArn :: Text

    The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

  • metrics :: [MetricAttribute]

    A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

  • metricsOutputConfig :: MetricAttributionOutput

    The output configuration details for the metric attribution.

Instances

Instances details
ToJSON CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

toJSON :: CreateMetricAttribution -> Value #

toEncoding :: CreateMetricAttribution -> Encoding #

toJSONList :: [CreateMetricAttribution] -> Value #

toEncodingList :: [CreateMetricAttribution] -> Encoding #

ToHeaders CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

toHeaders :: CreateMetricAttribution -> [Header] #

ToPath CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

toPath :: CreateMetricAttribution -> ByteString #

ToQuery CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

toQuery :: CreateMetricAttribution -> QueryString #

AWSRequest CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Associated Types

type AWSResponse CreateMetricAttribution #

Methods

request :: (Service -> Service) -> CreateMetricAttribution -> Request CreateMetricAttribution #

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

Generic CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Associated Types

type Rep CreateMetricAttribution :: Type -> Type #

Methods

from :: CreateMetricAttribution -> Rep CreateMetricAttribution x #

to :: Rep CreateMetricAttribution x -> CreateMetricAttribution #

Read CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

readsPrec :: Int -> ReadS CreateMetricAttribution #

readList :: ReadS [CreateMetricAttribution] #

readPrec :: ReadPrec CreateMetricAttribution #

readListPrec :: ReadPrec [CreateMetricAttribution] #

Show CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

showsPrec :: Int -> CreateMetricAttribution -> ShowS #

show :: CreateMetricAttribution -> String #

showList :: [CreateMetricAttribution] -> ShowS #

NFData CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

rnf :: CreateMetricAttribution -> () #

Eq CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

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

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

Hashable CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

hashWithSalt :: Int -> CreateMetricAttribution -> Int #

hash :: CreateMetricAttribution -> Int #

type AWSResponse CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

type AWSResponse CreateMetricAttribution = CreateMetricAttributionResponse
type Rep CreateMetricAttribution Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

type Rep CreateMetricAttribution = D1 ('MetaData "CreateMetricAttribution" "Amazonka.Personalize.CreateMetricAttribution" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateMetricAttribution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricAttribute]) :*: S1 ('MetaSel ('Just "metricsOutputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricAttributionOutput))))

newCreateMetricAttribution Source #

Arguments

:: Text

CreateMetricAttribution

-> Text

CreateMetricAttribution

-> MetricAttributionOutput

CreateMetricAttribution

-> CreateMetricAttribution 

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

CreateMetricAttribution, createMetricAttribution_name - A name for the metric attribution.

CreateMetricAttribution, createMetricAttribution_datasetGroupArn - The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

$sel:metrics:CreateMetricAttribution', createMetricAttribution_metrics - A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

CreateMetricAttribution, createMetricAttribution_metricsOutputConfig - The output configuration details for the metric attribution.

Request Lenses

createMetricAttribution_name :: Lens' CreateMetricAttribution Text Source #

A name for the metric attribution.

createMetricAttribution_datasetGroupArn :: Lens' CreateMetricAttribution Text Source #

The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

createMetricAttribution_metrics :: Lens' CreateMetricAttribution [MetricAttribute] Source #

A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

createMetricAttribution_metricsOutputConfig :: Lens' CreateMetricAttribution MetricAttributionOutput Source #

The output configuration details for the metric attribution.

Destructuring the Response

data CreateMetricAttributionResponse Source #

See: newCreateMetricAttributionResponse smart constructor.

Constructors

CreateMetricAttributionResponse' 

Fields

Instances

Instances details
Generic CreateMetricAttributionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Associated Types

type Rep CreateMetricAttributionResponse :: Type -> Type #

Methods

from :: CreateMetricAttributionResponse -> Rep CreateMetricAttributionResponse x #

to :: Rep CreateMetricAttributionResponse x -> CreateMetricAttributionResponse #

Read CreateMetricAttributionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

readsPrec :: Int -> ReadS CreateMetricAttributionResponse #

readList :: ReadS [CreateMetricAttributionResponse] #

readPrec :: ReadPrec CreateMetricAttributionResponse #

readListPrec :: ReadPrec [CreateMetricAttributionResponse] #

Show CreateMetricAttributionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

showsPrec :: Int -> CreateMetricAttributionResponse -> ShowS #

show :: CreateMetricAttributionResponse -> String #

showList :: [CreateMetricAttributionResponse] -> ShowS #

NFData CreateMetricAttributionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

rnf :: CreateMetricAttributionResponse -> () #

Eq CreateMetricAttributionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

Methods

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

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

type Rep CreateMetricAttributionResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateMetricAttribution

type Rep CreateMetricAttributionResponse = D1 ('MetaData "CreateMetricAttributionResponse" "Amazonka.Personalize.CreateMetricAttribution" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateMetricAttributionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricAttributionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateMetricAttributionResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateMetricAttributionResponse'

-> CreateMetricAttributionResponse 

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

CreateMetricAttributionResponse, createMetricAttributionResponse_metricAttributionArn - The Amazon Resource Name (ARN) for the new metric attribution.

$sel:httpStatus:CreateMetricAttributionResponse', createMetricAttributionResponse_httpStatus - The response's http status code.

Response Lenses

createMetricAttributionResponse_metricAttributionArn :: Lens' CreateMetricAttributionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the new metric attribution.

createMetricAttributionResponse_httpStatus :: Lens' CreateMetricAttributionResponse Int Source #

The response's http status code.