Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.DescribeTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data DescribeTags = DescribeTags' {
- tagValues :: Maybe [Text]
- resourceType :: Maybe Text
- resourceName :: Maybe Text
- tagKeys :: Maybe [Text]
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeTags :: DescribeTags
describeTags_tagValues :: Lens' DescribeTags (Maybe [Text])
describeTags_resourceType :: Lens' DescribeTags (Maybe Text)
describeTags_resourceName :: Lens' DescribeTags (Maybe Text)
describeTags_tagKeys :: Lens' DescribeTags (Maybe [Text])
describeTags_marker :: Lens' DescribeTags (Maybe Text)
describeTags_maxRecords :: Lens' DescribeTags (Maybe Int)
data DescribeTagsResponse = DescribeTagsResponse' {
- marker :: Maybe Text
- taggedResources :: Maybe [TaggedResource]
- httpStatus :: Int
}
newDescribeTagsResponse :: Int -> DescribeTagsResponse
describeTagsResponse_marker :: Lens' DescribeTagsResponse (Maybe Text)
describeTagsResponse_taggedResources :: Lens' DescribeTagsResponse (Maybe [TaggedResource])
describeTagsResponse_httpStatus :: Lens' DescribeTagsResponse Int

Creating a Request

data DescribeTags Source #

See: newDescribeTags smart constructor.

Constructors

DescribeTags'

Fields

tagValues :: Maybe [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.
resourceType :: Maybe Text
The type of resource with which you want to view tags. Valid resource types are:
- Cluster
- CIDR/IP
- 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 Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
resourceName :: Maybe Text
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
tagKeys :: Maybe [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.
marker :: 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.
maxRecords :: 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.

Instances

Instances details

Eq DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods (==) :: DescribeTags -> DescribeTags -> Bool # (/=) :: DescribeTags -> DescribeTags -> Bool #
Read DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods readsPrec :: Int -> ReadS DescribeTags # readList :: ReadS [DescribeTags] # readPrec :: ReadPrec DescribeTags # readListPrec :: ReadPrec [DescribeTags] #
Show DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods showsPrec :: Int -> DescribeTags -> ShowS # show :: DescribeTags -> String # showList :: [DescribeTags] -> ShowS #
Generic DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Associated Types type Rep DescribeTags :: Type -> Type # Methods from :: DescribeTags -> Rep DescribeTags x # to :: Rep DescribeTags x -> DescribeTags #
NFData DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods rnf :: DescribeTags -> () #
Hashable DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods hashWithSalt :: Int -> DescribeTags -> Int # hash :: DescribeTags -> Int #
AWSPager DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods page :: DescribeTags -> AWSResponse DescribeTags -> Maybe DescribeTags #
AWSRequest DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Associated Types type AWSResponse DescribeTags # Methods request :: DescribeTags -> Request DescribeTags # response :: MonadResource m => Logger -> Service -> Proxy DescribeTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTags))) #
ToHeaders DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods toHeaders :: DescribeTags -> [Header] #
ToPath DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods toPath :: DescribeTags -> ByteString #
ToQuery DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods toQuery :: DescribeTags -> QueryString #
type Rep DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags type Rep DescribeTags = D1 ('MetaData "DescribeTags" "Amazonka.Redshift.DescribeTags" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeTags'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse DescribeTags Source #
Instance details Defined in Amazonka.Redshift.DescribeTags type AWSResponse DescribeTags = DescribeTagsResponse

newDescribeTags :: DescribeTags Source #

Create a value of DescribeTags 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:tagValues:DescribeTags', describeTags_tagValues - 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.

$sel:resourceType:DescribeTags', describeTags_resourceType - The type of resource with which you want to view tags. Valid resource types are:

Cluster
CIDR/IP
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 Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

$sel:resourceName:DescribeTags', describeTags_resourceName - The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

$sel:tagKeys:DescribeTags', describeTags_tagKeys - 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.

$sel:marker:DescribeTags', describeTags_marker - 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.

$sel:maxRecords:DescribeTags', describeTags_maxRecords - 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.

Request Lenses

describeTags_tagValues :: Lens' DescribeTags (Maybe [Text]) Source #

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.

describeTags_resourceType :: Lens' DescribeTags (Maybe Text) Source #

The type of resource with which you want to view tags. Valid resource types are:

Cluster
CIDR/IP
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 Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

describeTags_resourceName :: Lens' DescribeTags (Maybe Text) Source #

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

describeTags_tagKeys :: Lens' DescribeTags (Maybe [Text]) Source #

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.

describeTags_marker :: Lens' DescribeTags (Maybe Text) Source #

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.

describeTags_maxRecords :: Lens' DescribeTags (Maybe Int) Source #

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

data DescribeTagsResponse Source #

See: newDescribeTagsResponse smart constructor.

Constructors

DescribeTagsResponse'

Fields

marker :: 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.
taggedResources :: Maybe [TaggedResource]
A list of tags with their associated resources.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeTagsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods (==) :: DescribeTagsResponse -> DescribeTagsResponse -> Bool # (/=) :: DescribeTagsResponse -> DescribeTagsResponse -> Bool #
Read DescribeTagsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods readsPrec :: Int -> ReadS DescribeTagsResponse # readList :: ReadS [DescribeTagsResponse] # readPrec :: ReadPrec DescribeTagsResponse # readListPrec :: ReadPrec [DescribeTagsResponse] #
Show DescribeTagsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods showsPrec :: Int -> DescribeTagsResponse -> ShowS # show :: DescribeTagsResponse -> String # showList :: [DescribeTagsResponse] -> ShowS #
Generic DescribeTagsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Associated Types type Rep DescribeTagsResponse :: Type -> Type # Methods from :: DescribeTagsResponse -> Rep DescribeTagsResponse x # to :: Rep DescribeTagsResponse x -> DescribeTagsResponse #
NFData DescribeTagsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTags Methods rnf :: DescribeTagsResponse -> () #
type Rep DescribeTagsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeTags type Rep DescribeTagsResponse = D1 ('MetaData "DescribeTagsResponse" "Amazonka.Redshift.DescribeTags" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "taggedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaggedResource])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTagsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTagsResponse'`
-> DescribeTagsResponse

Create a value of DescribeTagsResponse 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:marker:DescribeTags', describeTagsResponse_marker - 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.

$sel:taggedResources:DescribeTagsResponse', describeTagsResponse_taggedResources - A list of tags with their associated resources.

$sel:httpStatus:DescribeTagsResponse', describeTagsResponse_httpStatus - The response's http status code.

Response Lenses

describeTagsResponse_marker :: Lens' DescribeTagsResponse (Maybe Text) Source #

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.

describeTagsResponse_taggedResources :: Lens' DescribeTagsResponse (Maybe [TaggedResource]) Source #

A list of tags with their associated resources.

describeTagsResponse_httpStatus :: Lens' DescribeTagsResponse Int Source #

The response's http status code.