Network.AWS.Redshift.DescribeTags

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags :

• You cannot specify an ARN and a resource-type value together in the same request.
• You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
• The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Creating a Request

describeTags :: DescribeTags

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

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

• dtTagValues - A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
• dtResourceType - The type of resource with which you want to view tags. Valid resource types are: * Cluster * CIDRIP * EC2 security group * Snapshot * Cluster security group * Subnet group * HSM connection * HSM certificate * Parameter group * Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to <http:docs.aws.amazon.comredshiftlatestmgmt/constructing-redshift-arn.html Constructing an Amazon Redshift Amazon Resource Name (ARN)> in the Amazon Redshift Cluster Management Guide.
• dtResourceName - The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1 .
• dtTagKeys - A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
• dtMarker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
• dtMaxRecords - The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

data DescribeTags

See: describeTags smart constructor.

Instances

Eq DescribeTags

Methods

(==) :: DescribeTags -> DescribeTags -> Bool

(/=) :: DescribeTags -> DescribeTags -> Bool

Data DescribeTags

Methods

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

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

toConstr :: DescribeTags -> Constr

dataTypeOf :: DescribeTags -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeTags -> DescribeTags

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

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

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

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

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

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

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

Read DescribeTags

Methods

readsPrec :: Int -> ReadS DescribeTags

readList :: ReadS [DescribeTags]

readPrec :: ReadPrec DescribeTags

readListPrec :: ReadPrec [DescribeTags]

Show DescribeTags

Methods

showsPrec :: Int -> DescribeTags -> ShowS

show :: DescribeTags -> String

showList :: [DescribeTags] -> ShowS

Generic DescribeTags

Associated Types

type Rep DescribeTags :: * -> *

Methods

from :: DescribeTags -> Rep DescribeTags x

to :: Rep DescribeTags x -> DescribeTags

Hashable DescribeTags

Methods

hashWithSalt :: Int -> DescribeTags -> Int

hash :: DescribeTags -> Int

NFData DescribeTags

Methods

rnf :: DescribeTags -> ()

AWSRequest DescribeTags

Associated Types

type Rs DescribeTags :: *

Methods

request :: DescribeTags -> Request DescribeTags

response :: MonadResource m => Logger -> Service -> Proxy * DescribeTags -> ClientResponse -> m (Response DescribeTags)

ToPath DescribeTags

Methods

toPath :: DescribeTags -> ByteString

ToHeaders DescribeTags

Methods

toHeaders :: DescribeTags -> [Header]

ToQuery DescribeTags

Methods

toQuery :: DescribeTags -> QueryString

type Rep DescribeTags

type Rep DescribeTags = D1 (MetaData "DescribeTags" "Network.AWS.Redshift.DescribeTags" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeTags'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dtTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dtResourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dtResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_dtTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dtMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dtMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))))

type Rs DescribeTags

type Rs DescribeTags = DescribeTagsResponse

Request Lenses

dtTagValues :: Lens' DescribeTags [Text]

A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

dtResourceType :: Lens' DescribeTags (Maybe Text)

The type of resource with which you want to view tags. Valid resource types are: * Cluster * CIDRIP * EC2 security group * Snapshot * Cluster security group * Subnet group * HSM connection * HSM certificate * Parameter group * Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to <http:docs.aws.amazon.comredshiftlatestmgmt/constructing-redshift-arn.html Constructing an Amazon Redshift Amazon Resource Name (ARN)> in the Amazon Redshift Cluster Management Guide.

dtResourceName :: Lens' DescribeTags (Maybe Text)

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1 .

dtTagKeys :: Lens' DescribeTags [Text]

A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

dtMarker :: Lens' DescribeTags (Maybe Text)

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

dtMaxRecords :: Lens' DescribeTags (Maybe Int)

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Destructuring the Response

describeTagsResponse

Arguments

:: Int

dtrsResponseStatus

-> DescribeTagsResponse

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

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

• dtrsMarker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
• dtrsTaggedResources - A list of tags with their associated resources.
• dtrsResponseStatus - -- | The response status code.

data DescribeTagsResponse

See: describeTagsResponse smart constructor.

Instances

Eq DescribeTagsResponse

Methods

(==) :: DescribeTagsResponse -> DescribeTagsResponse -> Bool

(/=) :: DescribeTagsResponse -> DescribeTagsResponse -> Bool

Data DescribeTagsResponse

Methods

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

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

toConstr :: DescribeTagsResponse -> Constr

dataTypeOf :: DescribeTagsResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeTagsResponse -> DescribeTagsResponse

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

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

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

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

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

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

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

Read DescribeTagsResponse

Methods

readsPrec :: Int -> ReadS DescribeTagsResponse

readList :: ReadS [DescribeTagsResponse]

readPrec :: ReadPrec DescribeTagsResponse

readListPrec :: ReadPrec [DescribeTagsResponse]

Show DescribeTagsResponse

Methods

showsPrec :: Int -> DescribeTagsResponse -> ShowS

show :: DescribeTagsResponse -> String

showList :: [DescribeTagsResponse] -> ShowS

Generic DescribeTagsResponse

Associated Types

type Rep DescribeTagsResponse :: * -> *

Methods

from :: DescribeTagsResponse -> Rep DescribeTagsResponse x

to :: Rep DescribeTagsResponse x -> DescribeTagsResponse

NFData DescribeTagsResponse

Methods

rnf :: DescribeTagsResponse -> ()

type Rep DescribeTagsResponse

type Rep DescribeTagsResponse = D1 (MetaData "DescribeTagsResponse" "Network.AWS.Redshift.DescribeTags" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeTagsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dtrsTaggedResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [TaggedResource]))) (S1 (MetaSel (Just Symbol "_dtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dtrsMarker :: Lens' DescribeTagsResponse (Maybe Text)

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

dtrsTaggedResources :: Lens' DescribeTagsResponse [TaggedResource]

A list of tags with their associated resources.

dtrsResponseStatus :: Lens' DescribeTagsResponse Int

• - | The response status code.