Amazonka.XRay.CreateGroup

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

Creating a Request

data CreateGroup

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 NotificationsEnabled 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

ToJSON CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

toJSON :: CreateGroup -> Value

toEncoding :: CreateGroup -> Encoding

toJSONList :: [CreateGroup] -> Value

toEncodingList :: [CreateGroup] -> Encoding

ToHeaders CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

toHeaders :: CreateGroup -> [Header]

ToPath CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

toPath :: CreateGroup -> ByteString

ToQuery CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

toQuery :: CreateGroup -> QueryString

AWSRequest CreateGroup

Defined in Amazonka.XRay.CreateGroup

Associated Types

type AWSResponse CreateGroup

Methods

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

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

Generic CreateGroup

Defined in Amazonka.XRay.CreateGroup

Associated Types

type Rep CreateGroup :: Type -> Type

Methods

from :: CreateGroup -> Rep CreateGroup x

to :: Rep CreateGroup x -> CreateGroup

Read CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

readsPrec :: Int -> ReadS CreateGroup

readList :: ReadS [CreateGroup]

readPrec :: ReadPrec CreateGroup

readListPrec :: ReadPrec [CreateGroup]

Show CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

showsPrec :: Int -> CreateGroup -> ShowS

show :: CreateGroup -> String

showList :: [CreateGroup] -> ShowS

NFData CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

rnf :: CreateGroup -> ()

Eq CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

(==) :: CreateGroup -> CreateGroup -> Bool

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

Hashable CreateGroup

Defined in Amazonka.XRay.CreateGroup

Methods

hashWithSalt :: Int -> CreateGroup -> Int

hash :: CreateGroup -> Int

type AWSResponse CreateGroup

Defined in Amazonka.XRay.CreateGroup

type AWSResponse CreateGroup = CreateGroupResponse

type Rep CreateGroup

Defined in Amazonka.XRay.CreateGroup

type Rep CreateGroup = D1 ('MetaData "CreateGroup" "Amazonka.XRay.CreateGroup" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" '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))))

newCreateGroup

Arguments

:: Text

CreateGroup

-> CreateGroup

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:

CreateGroup, createGroup_filterExpression - The filter expression defining criteria by which to group traces.

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 NotificationsEnabled 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.

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)

The filter expression defining criteria by which to group traces.

createGroup_insightsConfiguration :: Lens' CreateGroup (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 NotificationsEnabled 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])

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

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

Destructuring the Response

data CreateGroupResponse

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

Generic CreateGroupResponse

Defined in Amazonka.XRay.CreateGroup

Associated Types

type Rep CreateGroupResponse :: Type -> Type

Methods

from :: CreateGroupResponse -> Rep CreateGroupResponse x

to :: Rep CreateGroupResponse x -> CreateGroupResponse

Read CreateGroupResponse

Defined in Amazonka.XRay.CreateGroup

Methods

readsPrec :: Int -> ReadS CreateGroupResponse

readList :: ReadS [CreateGroupResponse]

readPrec :: ReadPrec CreateGroupResponse

readListPrec :: ReadPrec [CreateGroupResponse]

Show CreateGroupResponse

Defined in Amazonka.XRay.CreateGroup

Methods

showsPrec :: Int -> CreateGroupResponse -> ShowS

show :: CreateGroupResponse -> String

showList :: [CreateGroupResponse] -> ShowS

NFData CreateGroupResponse

Defined in Amazonka.XRay.CreateGroup

Methods

rnf :: CreateGroupResponse -> ()

Eq CreateGroupResponse

Defined in Amazonka.XRay.CreateGroup

Methods

(==) :: CreateGroupResponse -> CreateGroupResponse -> Bool

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

type Rep CreateGroupResponse

Defined in Amazonka.XRay.CreateGroup

type Rep CreateGroupResponse = D1 ('MetaData "CreateGroupResponse" "Amazonka.XRay.CreateGroup" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" '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

Arguments

:: Int

CreateGroupResponse

-> CreateGroupResponse

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.

CreateGroupResponse, createGroupResponse_httpStatus - The response's http status code.

Response Lenses

createGroupResponse_group :: Lens' CreateGroupResponse (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.

createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int

The response's http status code.