/AWS1/IF_STG=>STARTCACHEREPORT()

About StartCacheReport

Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request.

The Files Failing Upload flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before they become flagged again, they will not be reported as Files Failing Upload.

The following requirements must be met to successfully generate a cache report:

• You must have s3:PutObject and s3:AbortMultipartUpload permissions for the Amazon S3 bucket where you want to store the cache report.

• No other cache reports can currently be in-progress for the specified file share.

• There must be fewer than 10 existing cache reports for the specified file share.

• The gateway must be online and connected to Amazon Web Services.

• The root disk must have at least 20GB of free space when report generation starts.

• You must specify at least one value for InclusionFilters or ExclusionFilters in the request.

Method Signature

METHODS /AWS1/IF_STG~STARTCACHEREPORT
  IMPORTING
    !IV_FILESHAREARN TYPE /AWS1/STGFILESHAREARN OPTIONAL
    !IV_ROLE TYPE /AWS1/STGROLE OPTIONAL
    !IV_LOCATIONARN TYPE /AWS1/STGLOCATIONARN OPTIONAL
    !IV_BUCKETREGION TYPE /AWS1/STGREGIONID OPTIONAL
    !IV_VPCENDPOINTDNSNAME TYPE /AWS1/STGDNSHOSTNAME OPTIONAL
    !IT_INCLUSIONFILTERS TYPE /AWS1/CL_STGCACHEREPORTFILTER=>TT_CACHEREPORTFILTERLIST OPTIONAL
    !IT_EXCLUSIONFILTERS TYPE /AWS1/CL_STGCACHEREPORTFILTER=>TT_CACHEREPORTFILTERLIST OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/STGCLIENTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_STGTAG=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_stgstartcacherptout
  RAISING
    /AWS1/CX_STGINTERNALSERVERERR
    /AWS1/CX_STGINVALIDGWREQUESTEX
    /AWS1/CX_STGCLIENTEXC
    /AWS1/CX_STGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_filesharearn TYPE /AWS1/STGFILESHAREARN /AWS1/STGFILESHAREARN

FileShareARN

iv_role TYPE /AWS1/STGROLE /AWS1/STGROLE

The ARN of the IAM role used when saving the cache report to Amazon S3.

iv_locationarn TYPE /AWS1/STGLOCATIONARN /AWS1/STGLOCATIONARN

The ARN of the Amazon S3 bucket where you want to save the cache report.

We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.

This field does not accept access point ARNs.

iv_bucketregion TYPE /AWS1/STGREGIONID /AWS1/STGREGIONID

The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.

iv_clienttoken TYPE /AWS1/STGCLIENTTOKEN /AWS1/STGCLIENTTOKEN

A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport request. If you retry a request, use the same ClientToken you specified in the initial request.

Optional arguments:

iv_vpcendpointdnsname TYPE /AWS1/STGDNSHOSTNAME /AWS1/STGDNSHOSTNAME

The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.

it_inclusionfilters TYPE /AWS1/CL_STGCACHEREPORTFILTER=>TT_CACHEREPORTFILTERLIST TT_CACHEREPORTFILTERLIST

The list of filters and parameters that determine which files are included in the report. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.

it_exclusionfilters TYPE /AWS1/CL_STGCACHEREPORTFILTER=>TT_CACHEREPORTFILTERLIST TT_CACHEREPORTFILTERLIST

The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.

it_tags TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS

A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgstartcacherptout /AWS1/CL_STGSTARTCACHERPTOUT

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->startcachereport(
  it_exclusionfilters = VALUE /aws1/cl_stgcachereportfilter=>tt_cachereportfilterlist(
    (
      new /aws1/cl_stgcachereportfilter(
        it_values = VALUE /aws1/cl_stgcacherptfiltvals_w=>tt_cachereportfiltervalues(
          ( new /aws1/cl_stgcacherptfiltvals_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_inclusionfilters = VALUE /aws1/cl_stgcachereportfilter=>tt_cachereportfilterlist(
    (
      new /aws1/cl_stgcachereportfilter(
        it_values = VALUE /aws1/cl_stgcacherptfiltvals_w=>tt_cachereportfiltervalues(
          ( new /aws1/cl_stgcacherptfiltvals_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_stgtag=>tt_tags(
    (
      new /aws1/cl_stgtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_bucketregion = |string|
  iv_clienttoken = |string|
  iv_filesharearn = |string|
  iv_locationarn = |string|
  iv_role = |string|
  iv_vpcendpointdnsname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_cachereportarn = lo_result->get_cachereportarn( ).
ENDIF.