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.Synthetics.CreateGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.

Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

Synopsis

data CreateGroup = CreateGroup' {
- tags :: Maybe (HashMap Text Text)
- name :: Text
}
newCreateGroup :: Text -> CreateGroup
createGroup_tags :: Lens' CreateGroup (Maybe (HashMap Text Text))
createGroup_name :: 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

tags :: Maybe (HashMap Text Text)
A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
name :: Text
The name for the group. It can include any Unicode characters.
The names for all groups in your account, across all Regions, must be unique.

Instances

Instances details

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

newCreateGroup Source #

Arguments

:: Text	`CreateGroup`
-> 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:

CreateGroup, createGroup_tags - A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

CreateGroup, createGroup_name - The name for the group. It can include any Unicode characters.

The names for all groups in your account, across all Regions, must be unique.

Request Lenses

createGroup_tags :: Lens' CreateGroup (Maybe (HashMap Text Text)) Source #

A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

createGroup_name :: Lens' CreateGroup Text Source #

The name for the group. It can include any Unicode characters.

The names for all groups in your account, across all Regions, must be unique.

Destructuring the Response

data CreateGroupResponse Source #

See: newCreateGroupResponse smart constructor.

Constructors

CreateGroupResponse'
Fields group' :: Maybe Group A structure that contains information about the group that was just created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.CreateGroup Associated Types type Rep CreateGroupResponse :: Type -> Type # Methods from :: CreateGroupResponse -> Rep CreateGroupResponse x # to :: Rep CreateGroupResponse x -> CreateGroupResponse #
Read CreateGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.CreateGroup Methods readsPrec :: Int -> ReadS CreateGroupResponse # readList :: ReadS [CreateGroupResponse] # readPrec :: ReadPrec CreateGroupResponse # readListPrec :: ReadPrec [CreateGroupResponse] #
Show CreateGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.CreateGroup Methods showsPrec :: Int -> CreateGroupResponse -> ShowS # show :: CreateGroupResponse -> String # showList :: [CreateGroupResponse] -> ShowS #
NFData CreateGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.CreateGroup Methods rnf :: CreateGroupResponse -> () #
Eq CreateGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.CreateGroup Methods (==) :: CreateGroupResponse -> CreateGroupResponse -> Bool # (/=) :: CreateGroupResponse -> CreateGroupResponse -> Bool #
type Rep CreateGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.CreateGroup type Rep CreateGroupResponse = D1 ('MetaData "CreateGroupResponse" "Amazonka.Synthetics.CreateGroup" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "CreateGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateGroupResponse'`
-> 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 - A structure that contains information about the group that was just created.

$sel:httpStatus:CreateGroupResponse', createGroupResponse_httpStatus - The response's http status code.

Response Lenses

createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group) Source #

A structure that contains information about the group that was just created.

createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int Source #

The response's http status code.