amazonka-redshift-2.0: Amazon Redshift 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.Redshift.DescribeSnapshotCopyGrants

Description

Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeSnapshotCopyGrants Source #

The result of the DescribeSnapshotCopyGrants action.

See: newDescribeSnapshotCopyGrants smart constructor.

Constructors

DescribeSnapshotCopyGrants' 

Fields

  • marker :: Maybe Text

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

  • maxRecords :: Maybe Int

    The maximum number of 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.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • snapshotCopyGrantName :: Maybe Text

    The name of the snapshot copy grant.

  • 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.

  • 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.

Instances

Instances details
ToHeaders DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

ToPath DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

ToQuery DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

AWSPager DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

AWSRequest DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Generic DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Associated Types

type Rep DescribeSnapshotCopyGrants :: Type -> Type #

Read DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Show DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

NFData DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Eq DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Hashable DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

type AWSResponse DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

type Rep DescribeSnapshotCopyGrants Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

type Rep DescribeSnapshotCopyGrants = D1 ('MetaData "DescribeSnapshotCopyGrants" "Amazonka.Redshift.DescribeSnapshotCopyGrants" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeSnapshotCopyGrants'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "snapshotCopyGrantName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeSnapshotCopyGrants :: DescribeSnapshotCopyGrants Source #

Create a value of DescribeSnapshotCopyGrants 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:

DescribeSnapshotCopyGrants, describeSnapshotCopyGrants_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

$sel:maxRecords:DescribeSnapshotCopyGrants', describeSnapshotCopyGrants_maxRecords - The maximum number of 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.

Default: 100

Constraints: minimum 20, maximum 100.

DescribeSnapshotCopyGrants, describeSnapshotCopyGrants_snapshotCopyGrantName - The name of the snapshot copy grant.

$sel:tagKeys:DescribeSnapshotCopyGrants', describeSnapshotCopyGrants_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:tagValues:DescribeSnapshotCopyGrants', describeSnapshotCopyGrants_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.

Request Lenses

describeSnapshotCopyGrants_marker :: Lens' DescribeSnapshotCopyGrants (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

describeSnapshotCopyGrants_maxRecords :: Lens' DescribeSnapshotCopyGrants (Maybe Int) Source #

The maximum number of 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.

Default: 100

Constraints: minimum 20, maximum 100.

describeSnapshotCopyGrants_tagKeys :: Lens' DescribeSnapshotCopyGrants (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.

describeSnapshotCopyGrants_tagValues :: Lens' DescribeSnapshotCopyGrants (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.

Destructuring the Response

data DescribeSnapshotCopyGrantsResponse Source #

Constructors

DescribeSnapshotCopyGrantsResponse' 

Fields

  • marker :: Maybe Text

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

  • snapshotCopyGrants :: Maybe [SnapshotCopyGrant]

    The list of SnapshotCopyGrant objects.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeSnapshotCopyGrantsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Associated Types

type Rep DescribeSnapshotCopyGrantsResponse :: Type -> Type #

Read DescribeSnapshotCopyGrantsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Show DescribeSnapshotCopyGrantsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

NFData DescribeSnapshotCopyGrantsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

Eq DescribeSnapshotCopyGrantsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

type Rep DescribeSnapshotCopyGrantsResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotCopyGrants

type Rep DescribeSnapshotCopyGrantsResponse = D1 ('MetaData "DescribeSnapshotCopyGrantsResponse" "Amazonka.Redshift.DescribeSnapshotCopyGrants" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeSnapshotCopyGrantsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snapshotCopyGrants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SnapshotCopyGrant])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSnapshotCopyGrantsResponse Source #

Create a value of DescribeSnapshotCopyGrantsResponse 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:

DescribeSnapshotCopyGrants, describeSnapshotCopyGrantsResponse_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

$sel:snapshotCopyGrants:DescribeSnapshotCopyGrantsResponse', describeSnapshotCopyGrantsResponse_snapshotCopyGrants - The list of SnapshotCopyGrant objects.

$sel:httpStatus:DescribeSnapshotCopyGrantsResponse', describeSnapshotCopyGrantsResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotCopyGrantsResponse_marker :: Lens' DescribeSnapshotCopyGrantsResponse (Maybe Text) Source #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.