libZSservicesZSamazonka-xrayZSamazonka-xray
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.XRay.CreateGroup

Description

Creates a group resource with a name and a filter expression.

Synopsis

Creating a Request

data CreateGroup Source #

See: newCreateGroup smart constructor.

Constructors

CreateGroup' 

Fields

  • filterExpression :: Maybe Text

    The filter expression defining criteria by which to group traces.

  • insightsConfiguration :: Maybe InsightsConfiguration

    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
    • The NotifcationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
  • tags :: Maybe [Tag]

    A map that contains one or more tag keys and tag values to attach to an X-Ray group. 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.
  • groupName :: Text

    The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Instances

Instances details
Eq CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Read CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Show CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Generic CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Associated Types

type Rep CreateGroup :: Type -> Type #

NFData CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Methods

rnf :: CreateGroup -> () #

Hashable CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

ToJSON CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

AWSRequest CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Associated Types

type AWSResponse CreateGroup #

ToHeaders CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Methods

toHeaders :: CreateGroup -> [Header] #

ToPath CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

ToQuery CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

type Rep CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

type Rep CreateGroup = D1 ('MetaData "CreateGroup" "Amazonka.XRay.CreateGroup" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "CreateGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "insightsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InsightsConfiguration))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateGroup Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

newCreateGroup Source #

Create a value of CreateGroup 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:filterExpression:CreateGroup', createGroup_filterExpression - The filter expression defining criteria by which to group traces.

$sel:insightsConfiguration:CreateGroup', createGroup_insightsConfiguration - The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
  • The NotifcationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

$sel:tags:CreateGroup', createGroup_tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group. 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.

$sel:groupName:CreateGroup', createGroup_groupName - The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Request Lenses

createGroup_filterExpression :: Lens' CreateGroup (Maybe Text) Source #

The filter expression defining criteria by which to group traces.

createGroup_insightsConfiguration :: Lens' CreateGroup (Maybe InsightsConfiguration) Source #

The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
  • The NotifcationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

createGroup_tags :: Lens' CreateGroup (Maybe [Tag]) Source #

A map that contains one or more tag keys and tag values to attach to an X-Ray group. 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.

createGroup_groupName :: Lens' CreateGroup Text Source #

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Destructuring the Response

data CreateGroupResponse Source #

See: newCreateGroupResponse smart constructor.

Constructors

CreateGroupResponse' 

Fields

  • group' :: Maybe Group

    The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Read CreateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Show CreateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Generic CreateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Associated Types

type Rep CreateGroupResponse :: Type -> Type #

NFData CreateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

Methods

rnf :: CreateGroupResponse -> () #

type Rep CreateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.CreateGroup

type Rep CreateGroupResponse = D1 ('MetaData "CreateGroupResponse" "Amazonka.XRay.CreateGroup" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "CreateGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGroupResponse Source #

Create a value of CreateGroupResponse 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:group':CreateGroupResponse', createGroupResponse_group - The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.

$sel:httpStatus:CreateGroupResponse', createGroupResponse_httpStatus - The response's http status code.

Response Lenses

createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group) Source #

The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.