aws_sdk_xray/client/
create_group.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateGroup`](crate::operation::create_group::builders::CreateGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`group_name(impl Into<String>)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::set_group_name):<br>required: **true**<br><p>The case-sensitive name of the new group. Default is a reserved name and names must be unique.</p><br>
    ///   - [`filter_expression(impl Into<String>)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::filter_expression) / [`set_filter_expression(Option<String>)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::set_filter_expression):<br>required: **false**<br><p>The filter expression defining criteria by which to group traces.</p><br>
    ///   - [`insights_configuration(InsightsConfiguration)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::insights_configuration) / [`set_insights_configuration(Option<InsightsConfiguration>)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::set_insights_configuration):<br>required: **false**<br><p>The structure containing configurations related to insights.</p> <ul>  <li>   <p>The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.</p></li>  <li>   <p>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.</p></li> </ul><br>
    ///   - [`tags(Tag)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_group::builders::CreateGroupFluentBuilder::set_tags):<br>required: **false**<br><p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul>  <li>   <p>Maximum number of user-applied tags per resource: 50</p></li>  <li>   <p>Maximum tag key length: 128 Unicode characters</p></li>  <li>   <p>Maximum tag value length: 256 Unicode characters</p></li>  <li>   <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p></li>  <li>   <p>Tag keys and values are case sensitive.</p></li>  <li>   <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p></li> </ul><br>
    /// - On success, responds with [`CreateGroupOutput`](crate::operation::create_group::CreateGroupOutput) with field(s):
    ///   - [`group(Option<Group>)`](crate::operation::create_group::CreateGroupOutput::group): <p>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.</p>
    /// - On failure, responds with [`SdkError<CreateGroupError>`](crate::operation::create_group::CreateGroupError)
    pub fn create_group(&self) -> crate::operation::create_group::builders::CreateGroupFluentBuilder {
        crate::operation::create_group::builders::CreateGroupFluentBuilder::new(self.handle.clone())
    }
}