Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.XRay.UpdateGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a group resource.

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.
groupARN :: Maybe Text
The ARN that was generated upon creation.
groupName :: Maybe Text
The case-sensitive name of the group.
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 NotificationsEnabled 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.

Instances

Instances details

ToJSON UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods toJSON :: UpdateGroup -> Value # toEncoding :: UpdateGroup -> Encoding # toJSONList :: [UpdateGroup] -> Value # toEncodingList :: [UpdateGroup] -> Encoding #
ToHeaders UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods toHeaders :: UpdateGroup -> [Header] #
ToPath UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods toPath :: UpdateGroup -> ByteString #
ToQuery UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods toQuery :: UpdateGroup -> QueryString #
AWSRequest UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Associated Types type AWSResponse UpdateGroup # Methods request :: (Service -> Service) -> UpdateGroup -> Request UpdateGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGroup))) #
Generic UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Associated Types type Rep UpdateGroup :: Type -> Type # Methods from :: UpdateGroup -> Rep UpdateGroup x # to :: Rep UpdateGroup x -> UpdateGroup #
Read UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroup # readList :: ReadS [UpdateGroup] # readPrec :: ReadPrec UpdateGroup # readListPrec :: ReadPrec [UpdateGroup] #
Show UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods showsPrec :: Int -> UpdateGroup -> ShowS # show :: UpdateGroup -> String # showList :: [UpdateGroup] -> ShowS #
NFData UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods rnf :: UpdateGroup -> () #
Eq UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods (==) :: UpdateGroup -> UpdateGroup -> Bool # (/=) :: UpdateGroup -> UpdateGroup -> Bool #
Hashable UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods hashWithSalt :: Int -> UpdateGroup -> Int # hash :: UpdateGroup -> Int #
type AWSResponse UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup type AWSResponse UpdateGroup = UpdateGroupResponse
type Rep UpdateGroup Source #
Instance details Defined in Amazonka.XRay.UpdateGroup type Rep UpdateGroup = D1 ('MetaData "UpdateGroup" "Amazonka.XRay.UpdateGroup" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "UpdateGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "insightsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InsightsConfiguration)))))

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:

UpdateGroup, updateGroup_filterExpression - The updated filter expression defining criteria by which to group traces.

UpdateGroup, updateGroup_groupARN - The ARN that was generated upon creation.

UpdateGroup, updateGroup_groupName - The case-sensitive name of the group.

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

Request Lenses

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

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

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.

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

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

Generic UpdateGroupResponse Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Associated Types type Rep UpdateGroupResponse :: Type -> Type # Methods from :: UpdateGroupResponse -> Rep UpdateGroupResponse x # to :: Rep UpdateGroupResponse x -> UpdateGroupResponse #
Read UpdateGroupResponse Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroupResponse # readList :: ReadS [UpdateGroupResponse] # readPrec :: ReadPrec UpdateGroupResponse # readListPrec :: ReadPrec [UpdateGroupResponse] #
Show UpdateGroupResponse Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods showsPrec :: Int -> UpdateGroupResponse -> ShowS # show :: UpdateGroupResponse -> String # showList :: [UpdateGroupResponse] -> ShowS #
NFData UpdateGroupResponse Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods rnf :: UpdateGroupResponse -> () #
Eq UpdateGroupResponse Source #
Instance details Defined in Amazonka.XRay.UpdateGroup Methods (==) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool # (/=) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool #
type Rep UpdateGroupResponse Source #
Instance details Defined in Amazonka.XRay.UpdateGroup type Rep UpdateGroupResponse = D1 ('MetaData "UpdateGroupResponse" "Amazonka.XRay.UpdateGroup" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" '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 #

Arguments

:: Int	`UpdateGroupResponse`
-> UpdateGroupResponse

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.

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.

updateGroupResponse_httpStatus :: Lens' UpdateGroupResponse Int Source #

The response's http status code.