Amazonka.XRay.CreateSamplingRule

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Creating a Request

data CreateSamplingRule

See: newCreateSamplingRule smart constructor.

Constructors

CreateSamplingRule'

Fields

• tags :: Maybe [Tag]

  A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

  The following restrictions apply to tags:

  • Maximum number of user-applied tags per resource: 50
  • Maximum tag key length: 128 Unicode characters
  • Maximum tag value length: 256 Unicode characters
  • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
  • Tag keys and values are case sensitive.
  • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
• samplingRule :: SamplingRule

  The rule definition.

Instances

ToJSON CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

toJSON :: CreateSamplingRule -> Value

toEncoding :: CreateSamplingRule -> Encoding

toJSONList :: [CreateSamplingRule] -> Value

toEncodingList :: [CreateSamplingRule] -> Encoding

ToHeaders CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

toHeaders :: CreateSamplingRule -> [Header]

ToPath CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

toPath :: CreateSamplingRule -> ByteString

ToQuery CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

toQuery :: CreateSamplingRule -> QueryString

AWSRequest CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Associated Types

type AWSResponse CreateSamplingRule

Methods

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

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

Generic CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Associated Types

type Rep CreateSamplingRule :: Type -> Type

Methods

from :: CreateSamplingRule -> Rep CreateSamplingRule x

to :: Rep CreateSamplingRule x -> CreateSamplingRule

Read CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

readsPrec :: Int -> ReadS CreateSamplingRule

readList :: ReadS [CreateSamplingRule]

readPrec :: ReadPrec CreateSamplingRule

readListPrec :: ReadPrec [CreateSamplingRule]

Show CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

showsPrec :: Int -> CreateSamplingRule -> ShowS

show :: CreateSamplingRule -> String

showList :: [CreateSamplingRule] -> ShowS

NFData CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

rnf :: CreateSamplingRule -> ()

Eq CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

(==) :: CreateSamplingRule -> CreateSamplingRule -> Bool

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

Hashable CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

Methods

hashWithSalt :: Int -> CreateSamplingRule -> Int

hash :: CreateSamplingRule -> Int

type AWSResponse CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

type AWSResponse CreateSamplingRule = CreateSamplingRuleResponse

type Rep CreateSamplingRule

Defined in Amazonka.XRay.CreateSamplingRule

type Rep CreateSamplingRule = D1 ('MetaData "CreateSamplingRule" "Amazonka.XRay.CreateSamplingRule" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "CreateSamplingRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "samplingRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SamplingRule)))

newCreateSamplingRule

Arguments

:: SamplingRule

CreateSamplingRule

-> CreateSamplingRule

Create a value of CreateSamplingRule 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:tags:CreateSamplingRule', createSamplingRule_tags - A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50
• Maximum tag key length: 128 Unicode characters
• Maximum tag value length: 256 Unicode characters
• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
• Tag keys and values are case sensitive.
• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

CreateSamplingRule, createSamplingRule_samplingRule - The rule definition.

Request Lenses

createSamplingRule_tags :: Lens' CreateSamplingRule (Maybe [Tag])

A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50
• Maximum tag key length: 128 Unicode characters
• Maximum tag value length: 256 Unicode characters
• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
• Tag keys and values are case sensitive.
• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

createSamplingRule_samplingRule :: Lens' CreateSamplingRule SamplingRule

The rule definition.

Destructuring the Response

data CreateSamplingRuleResponse

See: newCreateSamplingRuleResponse smart constructor.

Constructors

CreateSamplingRuleResponse'

Fields

• samplingRuleRecord :: Maybe SamplingRuleRecord

  The saved rule definition and metadata.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateSamplingRuleResponse

Defined in Amazonka.XRay.CreateSamplingRule

Associated Types

type Rep CreateSamplingRuleResponse :: Type -> Type

Methods

from :: CreateSamplingRuleResponse -> Rep CreateSamplingRuleResponse x

to :: Rep CreateSamplingRuleResponse x -> CreateSamplingRuleResponse

Read CreateSamplingRuleResponse

Defined in Amazonka.XRay.CreateSamplingRule

Methods

readsPrec :: Int -> ReadS CreateSamplingRuleResponse

readList :: ReadS [CreateSamplingRuleResponse]

readPrec :: ReadPrec CreateSamplingRuleResponse

readListPrec :: ReadPrec [CreateSamplingRuleResponse]

Show CreateSamplingRuleResponse

Defined in Amazonka.XRay.CreateSamplingRule

Methods

showsPrec :: Int -> CreateSamplingRuleResponse -> ShowS

show :: CreateSamplingRuleResponse -> String

showList :: [CreateSamplingRuleResponse] -> ShowS

NFData CreateSamplingRuleResponse

Defined in Amazonka.XRay.CreateSamplingRule

Methods

rnf :: CreateSamplingRuleResponse -> ()

Eq CreateSamplingRuleResponse

Defined in Amazonka.XRay.CreateSamplingRule

Methods

(==) :: CreateSamplingRuleResponse -> CreateSamplingRuleResponse -> Bool

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

type Rep CreateSamplingRuleResponse

Defined in Amazonka.XRay.CreateSamplingRule

type Rep CreateSamplingRuleResponse = D1 ('MetaData "CreateSamplingRuleResponse" "Amazonka.XRay.CreateSamplingRule" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "CreateSamplingRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "samplingRuleRecord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SamplingRuleRecord)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSamplingRuleResponse

Arguments

:: Int

CreateSamplingRuleResponse

-> CreateSamplingRuleResponse

Create a value of CreateSamplingRuleResponse 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:samplingRuleRecord:CreateSamplingRuleResponse', createSamplingRuleResponse_samplingRuleRecord - The saved rule definition and metadata.

CreateSamplingRuleResponse, createSamplingRuleResponse_httpStatus - The response's http status code.

Response Lenses

createSamplingRuleResponse_samplingRuleRecord :: Lens' CreateSamplingRuleResponse (Maybe SamplingRuleRecord)

The saved rule definition and metadata.

createSamplingRuleResponse_httpStatus :: Lens' CreateSamplingRuleResponse Int

The response's http status code.