| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.XRay.CreateGroup
Description
Creates a group resource with a name and a filter expression.
Synopsis
- data CreateGroup = CreateGroup' {}
- newCreateGroup :: Text -> CreateGroup
- createGroup_filterExpression :: Lens' CreateGroup (Maybe Text)
- createGroup_insightsConfiguration :: Lens' CreateGroup (Maybe InsightsConfiguration)
- createGroup_tags :: Lens' CreateGroup (Maybe [Tag])
- createGroup_groupName :: Lens' CreateGroup Text
- data CreateGroupResponse = CreateGroupResponse' {
- group' :: Maybe Group
- httpStatus :: Int
- newCreateGroupResponse :: Int -> CreateGroupResponse
- createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group)
- createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int
Creating a Request
data CreateGroup Source #
See: newCreateGroup smart constructor.
Constructors
| CreateGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:
$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
| |
Instances
newCreateGroupResponse Source #
Arguments
| :: Int | |
| -> 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.
$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.
createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int Source #
The response's http status code.