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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

```
resource-groups:UpdateGroup
```

Synopsis

Creating a Request

data UpdateGroup Source #

See: newUpdateGroup smart constructor.

Constructors

UpdateGroup'
Fields description :: Maybe Text The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces. group' :: Maybe Text The name or the ARN of the resource group to modify. groupName :: Maybe Text Don't use this parameter. Use `Group` instead.

Instances

Instances details

ToJSON UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods toJSON :: UpdateGroup -> Value # toEncoding :: UpdateGroup -> Encoding # toJSONList :: [UpdateGroup] -> Value # toEncodingList :: [UpdateGroup] -> Encoding #
ToHeaders UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods toHeaders :: UpdateGroup -> [Header] #
ToPath UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods toPath :: UpdateGroup -> ByteString #
ToQuery UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods toQuery :: UpdateGroup -> QueryString #
AWSRequest UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.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.ResourceGroups.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.ResourceGroups.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroup # readList :: ReadS [UpdateGroup] # readPrec :: ReadPrec UpdateGroup # readListPrec :: ReadPrec [UpdateGroup] #
Show UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods showsPrec :: Int -> UpdateGroup -> ShowS # show :: UpdateGroup -> String # showList :: [UpdateGroup] -> ShowS #
NFData UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods rnf :: UpdateGroup -> () #
Eq UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods (==) :: UpdateGroup -> UpdateGroup -> Bool # (/=) :: UpdateGroup -> UpdateGroup -> Bool #
Hashable UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods hashWithSalt :: Int -> UpdateGroup -> Int # hash :: UpdateGroup -> Int #
type AWSResponse UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup type AWSResponse UpdateGroup = UpdateGroupResponse
type Rep UpdateGroup Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup type Rep UpdateGroup = D1 ('MetaData "UpdateGroup" "Amazonka.ResourceGroups.UpdateGroup" "amazonka-resourcegroups-2.0-B1PbpVYkdAmDCiu1dJFqfU" 'False) (C1 ('MetaCons "UpdateGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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_description - The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

UpdateGroup, updateGroup_group - The name or the ARN of the resource group to modify.

UpdateGroup, updateGroup_groupName - Don't use this parameter. Use Group instead.

Request Lenses

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

The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

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

The name or the ARN of the resource group to modify.

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

Don't use this parameter. Use Group instead.

Destructuring the Response

data UpdateGroupResponse Source #

See: newUpdateGroupResponse smart constructor.

Constructors

UpdateGroupResponse'
Fields group' :: Maybe Group The update description of the resource group. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateGroupResponse Source #
Instance details Defined in Amazonka.ResourceGroups.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.ResourceGroups.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroupResponse # readList :: ReadS [UpdateGroupResponse] # readPrec :: ReadPrec UpdateGroupResponse # readListPrec :: ReadPrec [UpdateGroupResponse] #
Show UpdateGroupResponse Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods showsPrec :: Int -> UpdateGroupResponse -> ShowS # show :: UpdateGroupResponse -> String # showList :: [UpdateGroupResponse] -> ShowS #
NFData UpdateGroupResponse Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods rnf :: UpdateGroupResponse -> () #
Eq UpdateGroupResponse Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup Methods (==) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool # (/=) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool #
type Rep UpdateGroupResponse Source #
Instance details Defined in Amazonka.ResourceGroups.UpdateGroup type Rep UpdateGroupResponse = D1 ('MetaData "UpdateGroupResponse" "Amazonka.ResourceGroups.UpdateGroup" "amazonka-resourcegroups-2.0-B1PbpVYkdAmDCiu1dJFqfU" '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	`$sel:httpStatus: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:

UpdateGroup, updateGroupResponse_group - The update description of the resource group.

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

Response Lenses

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

The update description of the resource group.

updateGroupResponse_httpStatus :: Lens' UpdateGroupResponse Int Source #

The response's http status code.