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

Description

Updates a group resource.

Synopsis

Creating a Request

data UpdateGroup Source #

See: newUpdateGroup smart constructor.

Constructors

UpdateGroup' 

Fields

  • filterExpression :: Maybe Text

    The updated 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 group or false to disable insights for the group.
    • The NotifcationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
  • groupARN :: Maybe Text

    The ARN that was generated upon creation.

  • groupName :: Maybe Text

    The case-sensitive name of the group.

Instances

Instances details
Eq UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Read UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Show UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Generic UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Associated Types

type Rep UpdateGroup :: Type -> Type #

NFData UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Methods

rnf :: UpdateGroup -> () #

Hashable UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

ToJSON UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

AWSRequest UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Associated Types

type AWSResponse UpdateGroup #

ToHeaders UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Methods

toHeaders :: UpdateGroup -> [Header] #

ToPath UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

ToQuery UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

type Rep UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

type Rep UpdateGroup = D1 ('MetaData "UpdateGroup" "Amazonka.XRay.UpdateGroup" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "UpdateGroup'" '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 "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse UpdateGroup Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

newUpdateGroup :: UpdateGroup Source #

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

$sel:insightsConfiguration:UpdateGroup', updateGroup_insightsConfiguration - The structure containing configurations related to insights.

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

$sel:groupARN:UpdateGroup', updateGroup_groupARN - The ARN that was generated upon creation.

$sel:groupName:UpdateGroup', updateGroup_groupName - The case-sensitive name of the group.

Request Lenses

updateGroup_filterExpression :: Lens' UpdateGroup (Maybe Text) Source #

The updated filter expression defining criteria by which to group traces.

updateGroup_insightsConfiguration :: Lens' UpdateGroup (Maybe InsightsConfiguration) Source #

The structure containing configurations related to insights.

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

updateGroup_groupARN :: Lens' UpdateGroup (Maybe Text) Source #

The ARN that was generated upon creation.

updateGroup_groupName :: Lens' UpdateGroup (Maybe Text) Source #

The case-sensitive name of the group.

Destructuring the Response

data UpdateGroupResponse Source #

See: newUpdateGroupResponse smart constructor.

Constructors

UpdateGroupResponse' 

Fields

  • group' :: Maybe Group

    The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq UpdateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Read UpdateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Show UpdateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Generic UpdateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Associated Types

type Rep UpdateGroupResponse :: Type -> Type #

NFData UpdateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

Methods

rnf :: UpdateGroupResponse -> () #

type Rep UpdateGroupResponse Source # 
Instance details

Defined in Amazonka.XRay.UpdateGroup

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

newUpdateGroupResponse Source #

Create a value of UpdateGroupResponse 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':UpdateGroupResponse', updateGroupResponse_group - The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.

$sel:httpStatus:UpdateGroupResponse', updateGroupResponse_httpStatus - The response's http status code.

Response Lenses

updateGroupResponse_group :: Lens' UpdateGroupResponse (Maybe Group) Source #

The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.