/AWS1/IF_EC2=>DESCRIBESNAPSHOTATTRIBUTE()¶
About DescribeSnapshotAttribute¶
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
Method Signature¶
METHODS /AWS1/IF_EC2~DESCRIBESNAPSHOTATTRIBUTE
IMPORTING
!IV_ATTRIBUTE TYPE /AWS1/EC2SNAPSHOTATTRIBUTENAME OPTIONAL
!IV_SNAPSHOTID TYPE /AWS1/EC2SNAPSHOTID OPTIONAL
!IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descrsnapattrrslt
RAISING
/AWS1/CX_EC2CLIENTEXC
/AWS1/CX_EC2SERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_attribute TYPE /AWS1/EC2SNAPSHOTATTRIBUTENAME /AWS1/EC2SNAPSHOTATTRIBUTENAME¶
The snapshot attribute you would like to view.
iv_snapshotid TYPE /AWS1/EC2SNAPSHOTID /AWS1/EC2SNAPSHOTID¶
The ID of the EBS snapshot.
Optional arguments:¶
iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_ec2descrsnapattrrslt /AWS1/CL_EC2DESCRSNAPATTRRSLT¶
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->describesnapshotattribute(
iv_attribute = |string|
iv_dryrun = ABAP_TRUE
iv_snapshotid = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
LOOP AT lo_result->get_productcodes( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_string = lo_row_1->get_productcodeid( ).
lv_productcodevalues = lo_row_1->get_productcodetype( ).
ENDIF.
ENDLOOP.
lv_string = lo_result->get_snapshotid( ).
LOOP AT lo_result->get_createvolumepermissions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_string = lo_row_3->get_userid( ).
lv_permissiongroup = lo_row_3->get_group( ).
ENDIF.
ENDLOOP.
ENDIF.
To describe snapshot attributes¶
This example describes the createVolumePermission attribute on a snapshot with the snapshot ID of snap-066877671789bd71b.
DATA(lo_result) = lo_client->describesnapshotattribute(
iv_attribute = |createVolumePermission|
iv_snapshotid = |snap-066877671789bd71b|
).