amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.TagResource

Description

Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

  • Build
  • Script
  • Fleet
  • Alias
  • GameSessionQueue
  • MatchmakingConfiguration
  • MatchmakingRuleSet

To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.

Learn more

Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

Amazon Web Services Tagging Strategies

Related actions

All APIs by task

Synopsis

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' 

Fields

  • resourceARN :: Text

    The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

  • tags :: [Tag]

    A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for actual tagging limits.

Instances

Instances details
ToJSON TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Associated Types

type AWSResponse TagResource #

Generic TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

Read TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

NFData TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Methods

rnf :: TagResource -> () #

Eq TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Hashable TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.GameLift.TagResource" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

newTagResource Source #

Create a value of TagResource 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:resourceARN:TagResource', tagResource_resourceARN - The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

$sel:tags:TagResource', tagResource_tags - A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for actual tagging limits.

Request Lenses

tagResource_resourceARN :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for actual tagging limits.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse' 

Fields

Instances

Instances details
Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

Methods

rnf :: TagResourceResponse -> () #

Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.GameLift.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.GameLift.TagResource" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

Response Lenses