DESCRIBESNAPSHOTCOPYGRANTS()`¶

About DescribeSnapshotCopyGrants¶

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.

Method Signature¶

METHODS /AWS1/IF_RSH~DESCRIBESNAPSHOTCOPYGRANTS
  IMPORTING
    !IV_SNAPSHOTCOPYGRANTNAME TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RSHSTRING OPTIONAL
    !IT_TAGKEYS TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST OPTIONAL
    !IT_TAGVALUES TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshsnapcopygrantmsg
  RAISING
    /AWS1/CX_RSHINVALIDTAGFAULT
    /AWS1/CX_RSHSNAPCPGRANTNOTFN00
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_snapshotcopygrantname` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The name of the snapshot copy grant.

`iv_maxrecords` `TYPE /AWS1/RSHINTEGEROPTIONAL` `/AWS1/RSHINTEGEROPTIONAL`¶

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.

`iv_marker` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

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.

`it_tagkeys` `TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST` `TT_TAGKEYLIST`¶

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.

`it_tagvalues` `TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST` `TT_TAGVALUELIST`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rshsnapcopygrantmsg` `/AWS1/CL_RSHSNAPCOPYGRANTMSG`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describesnapshotcopygrants(
  it_tagkeys = VALUE /aws1/cl_rshtagkeylist_w=>tt_tagkeylist(
    ( new /aws1/cl_rshtagkeylist_w( |string| ) )
  )
  it_tagvalues = VALUE /aws1/cl_rshtagvaluelist_w=>tt_tagvaluelist(
    ( new /aws1/cl_rshtagvaluelist_w( |string| ) )
  )
  iv_marker = |string|
  iv_maxrecords = 123
  iv_snapshotcopygrantname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_snapshotcopygrants( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_snapshotcopygrantname( ).
      lv_string = lo_row_1->get_kmskeyid( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_RSH=>DESCRIBESNAPSHOTCOPYGRANTS()¶