amazonka-resourcegroupstagging-1.6.0: Amazon Resource Groups Tagging API SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ResourceGroupsTagging

Contents

Description

Resource Groups Tagging API

This guide describes the API operations for the resource groups tagging.

A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of "Stack." But the value of Stack might be Testing for one and Production for the other.

Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. For more information about tagging, see Working with Tag Editor and Working with Resource Groups . For more information about permissions you need to use the resource groups tagging APIs, see Obtaining Permissions for Resource Groups and Obtaining Permissions for Tagging .

You can use the resource groups tagging APIs to complete the following tasks:

  • Tag and untag supported resources located in the specified region for the AWS account
  • Use tag-based filters to search for resources located in the specified region for the AWS account
  • List all existing tag keys in the specified region for the AWS account
  • List all existing values for the specified key in the specified region for the AWS account

Not all resources can have tags. For a lists of resources that you can tag, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide .

To make full use of the resource groups tagging APIs, you might need additional IAM permissions, including permission to access the resources of individual services as well as permission to view and apply tags to those resources. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide .

Synopsis

Service Configuration

resourceGroupsTagging :: Service Source #

API version 2017-01-26 of the Amazon Resource Groups Tagging API SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by ResourceGroupsTagging.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

ThrottledException

_ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was denied to limit the frequency of submitted requests.

PaginationTokenExpiredException

_PaginationTokenExpiredException :: AsError a => Getting (First ServiceError) a ServiceError Source #

A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

InternalServiceException

_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request processing failed because of an unknown error, exception, or failure. You can retry the request.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetTagKeys (Paginated)

TagResources

GetTagValues (Paginated)

GetResources (Paginated)

UntagResources

Types

ResourceErrorCode

data ResourceErrorCode Source #

Instances

Bounded ResourceErrorCode Source # 
Enum ResourceErrorCode Source # 
Eq ResourceErrorCode Source # 
Data ResourceErrorCode Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResourceErrorCode -> c ResourceErrorCode #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResourceErrorCode #

toConstr :: ResourceErrorCode -> Constr #

dataTypeOf :: ResourceErrorCode -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ResourceErrorCode) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResourceErrorCode) #

gmapT :: (forall b. Data b => b -> b) -> ResourceErrorCode -> ResourceErrorCode #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResourceErrorCode -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResourceErrorCode -> r #

gmapQ :: (forall d. Data d => d -> u) -> ResourceErrorCode -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResourceErrorCode -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResourceErrorCode -> m ResourceErrorCode #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResourceErrorCode -> m ResourceErrorCode #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResourceErrorCode -> m ResourceErrorCode #

Ord ResourceErrorCode Source # 
Read ResourceErrorCode Source # 
Show ResourceErrorCode Source # 
Generic ResourceErrorCode Source # 
Hashable ResourceErrorCode Source # 
FromJSON ResourceErrorCode Source # 
NFData ResourceErrorCode Source # 

Methods

rnf :: ResourceErrorCode -> () #

ToHeader ResourceErrorCode Source # 
ToQuery ResourceErrorCode Source # 
ToByteString ResourceErrorCode Source # 
FromText ResourceErrorCode Source # 
ToText ResourceErrorCode Source # 
type Rep ResourceErrorCode Source # 
type Rep ResourceErrorCode = D1 * (MetaData "ResourceErrorCode" "Network.AWS.ResourceGroupsTagging.Types.Sum" "amazonka-resourcegroupstagging-1.6.0-5L2Cxw2zEoEKPDJx4TkmLS" False) ((:+:) * (C1 * (MetaCons "InternalServiceException" PrefixI False) (U1 *)) (C1 * (MetaCons "InvalidParameterException" PrefixI False) (U1 *)))

FailureInfo

data FailureInfo Source #

Details of the common errors that all actions return.

See: failureInfo smart constructor.

Instances

Eq FailureInfo Source # 
Data FailureInfo Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FailureInfo -> c FailureInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FailureInfo #

toConstr :: FailureInfo -> Constr #

dataTypeOf :: FailureInfo -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FailureInfo) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FailureInfo) #

gmapT :: (forall b. Data b => b -> b) -> FailureInfo -> FailureInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FailureInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FailureInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> FailureInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FailureInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FailureInfo -> m FailureInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FailureInfo -> m FailureInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FailureInfo -> m FailureInfo #

Read FailureInfo Source # 
Show FailureInfo Source # 
Generic FailureInfo Source # 

Associated Types

type Rep FailureInfo :: * -> * #

Hashable FailureInfo Source # 
FromJSON FailureInfo Source # 
NFData FailureInfo Source # 

Methods

rnf :: FailureInfo -> () #

type Rep FailureInfo Source # 
type Rep FailureInfo = D1 * (MetaData "FailureInfo" "Network.AWS.ResourceGroupsTagging.Types.Product" "amazonka-resourcegroupstagging-1.6.0-5L2Cxw2zEoEKPDJx4TkmLS" False) (C1 * (MetaCons "FailureInfo'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_fiErrorCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ResourceErrorCode))) ((:*:) * (S1 * (MetaSel (Just Symbol "_fiErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_fiStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))

failureInfo :: FailureInfo Source #

Creates a value of FailureInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • fiErrorCode - The code of the common error. Valid values include InternalServiceException , InvalidParameterException , and any valid error code returned by the AWS service that hosts the resource that you want to tag.
  • fiErrorMessage - The message of the common error.
  • fiStatusCode - The HTTP status code of the common error.

fiErrorCode :: Lens' FailureInfo (Maybe ResourceErrorCode) Source #

The code of the common error. Valid values include InternalServiceException , InvalidParameterException , and any valid error code returned by the AWS service that hosts the resource that you want to tag.

fiErrorMessage :: Lens' FailureInfo (Maybe Text) Source #

The message of the common error.

fiStatusCode :: Lens' FailureInfo (Maybe Int) Source #

The HTTP status code of the common error.

ResourceTagMapping

data ResourceTagMapping Source #

A list of resource ARNs and the tags (keys and values) that are associated with each.

See: resourceTagMapping smart constructor.

Instances

Eq ResourceTagMapping Source # 
Data ResourceTagMapping Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResourceTagMapping -> c ResourceTagMapping #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResourceTagMapping #

toConstr :: ResourceTagMapping -> Constr #

dataTypeOf :: ResourceTagMapping -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ResourceTagMapping) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResourceTagMapping) #

gmapT :: (forall b. Data b => b -> b) -> ResourceTagMapping -> ResourceTagMapping #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResourceTagMapping -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResourceTagMapping -> r #

gmapQ :: (forall d. Data d => d -> u) -> ResourceTagMapping -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResourceTagMapping -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResourceTagMapping -> m ResourceTagMapping #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResourceTagMapping -> m ResourceTagMapping #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResourceTagMapping -> m ResourceTagMapping #

Read ResourceTagMapping Source # 
Show ResourceTagMapping Source # 
Generic ResourceTagMapping Source # 
Hashable ResourceTagMapping Source # 
FromJSON ResourceTagMapping Source # 
NFData ResourceTagMapping Source # 

Methods

rnf :: ResourceTagMapping -> () #

type Rep ResourceTagMapping Source # 
type Rep ResourceTagMapping = D1 * (MetaData "ResourceTagMapping" "Network.AWS.ResourceGroupsTagging.Types.Product" "amazonka-resourcegroupstagging-1.6.0-5L2Cxw2zEoEKPDJx4TkmLS" False) (C1 * (MetaCons "ResourceTagMapping'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtmResourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rtmTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag])))))

resourceTagMapping :: ResourceTagMapping Source #

Creates a value of ResourceTagMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • rtmResourceARN - An array of resource ARN(s).
  • rtmTags - The tags that have been applied to one or more AWS resources.

rtmResourceARN :: Lens' ResourceTagMapping (Maybe Text) Source #

An array of resource ARN(s).

rtmTags :: Lens' ResourceTagMapping [Tag] Source #

The tags that have been applied to one or more AWS resources.

Tag

data Tag Source #

The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics in the Amazon EC2 User Guide for Linux Instances .

See: tag smart constructor.

Instances

Eq Tag Source # 

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Data Tag Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag #

toConstr :: Tag -> Constr #

dataTypeOf :: Tag -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Tag) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) #

gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #

Read Tag Source # 
Show Tag Source # 

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag Source # 

Associated Types

type Rep Tag :: * -> * #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Hashable Tag Source # 

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

FromJSON Tag Source # 
NFData Tag Source # 

Methods

rnf :: Tag -> () #

type Rep Tag Source # 
type Rep Tag = D1 * (MetaData "Tag" "Network.AWS.ResourceGroupsTagging.Types.Product" "amazonka-resourcegroupstagging-1.6.0-5L2Cxw2zEoEKPDJx4TkmLS" False) (C1 * (MetaCons "Tag'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

tag Source #

Arguments

:: Text

tagKey

-> Text

tagValue

-> Tag 

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • tagKey - One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  • tagValue - The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

tagKey :: Lens' Tag Text Source #

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

tagValue :: Lens' Tag Text Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

TagFilter

data TagFilter Source #

A list of tags (keys and values) that are used to specify the associated resources.

See: tagFilter smart constructor.

Instances

Eq TagFilter Source # 
Data TagFilter Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TagFilter -> c TagFilter #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TagFilter #

toConstr :: TagFilter -> Constr #

dataTypeOf :: TagFilter -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TagFilter) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TagFilter) #

gmapT :: (forall b. Data b => b -> b) -> TagFilter -> TagFilter #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TagFilter -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TagFilter -> r #

gmapQ :: (forall d. Data d => d -> u) -> TagFilter -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TagFilter -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TagFilter -> m TagFilter #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TagFilter -> m TagFilter #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TagFilter -> m TagFilter #

Read TagFilter Source # 
Show TagFilter Source # 
Generic TagFilter Source # 

Associated Types

type Rep TagFilter :: * -> * #

Hashable TagFilter Source # 
ToJSON TagFilter Source # 
NFData TagFilter Source # 

Methods

rnf :: TagFilter -> () #

type Rep TagFilter Source # 
type Rep TagFilter = D1 * (MetaData "TagFilter" "Network.AWS.ResourceGroupsTagging.Types.Product" "amazonka-resourcegroupstagging-1.6.0-5L2Cxw2zEoEKPDJx4TkmLS" False) (C1 * (MetaCons "TagFilter'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_tfValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_tfKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

tagFilter :: TagFilter Source #

Creates a value of TagFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • tfValues - The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
  • tfKey - One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

tfValues :: Lens' TagFilter [Text] Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

tfKey :: Lens' TagFilter (Maybe Text) Source #

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.