PUTCOMPONENTPOLICY()`¶

About PutComponentPolicy¶

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Method Signature¶

METHODS /AWS1/IF_IMG~PUTCOMPONENTPOLICY
  IMPORTING
    !IV_COMPONENTARN TYPE /AWS1/IMGCOMPONENTBUILDVRSARN OPTIONAL
    !IV_POLICY TYPE /AWS1/IMGRESOURCEPOLICYDOC OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_imgputcomponentplyrsp
  RAISING
    /AWS1/CX_IMGCALLRLIMEXCEEDEDEX
    /AWS1/CX_IMGCLIENTEXCEPTION
    /AWS1/CX_IMGFORBIDDENEXCEPTION
    /AWS1/CX_IMGINVPARAMVALUEEX
    /AWS1/CX_IMGINVALIDREQUESTEX
    /AWS1/CX_IMGRESOURCENOTFOUNDEX
    /AWS1/CX_IMGSERVICEEXCEPTION
    /AWS1/CX_IMGSERVICEUNAVAILEX
    /AWS1/CX_IMGCLIENTEXC
    /AWS1/CX_IMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_componentarn` `TYPE /AWS1/IMGCOMPONENTBUILDVRSARN` `/AWS1/IMGCOMPONENTBUILDVRSARN`¶

The Amazon Resource Name (ARN) of the component that this policy should be applied to.

`iv_policy` `TYPE /AWS1/IMGRESOURCEPOLICYDOC` `/AWS1/IMGRESOURCEPOLICYDOC`¶

The policy to apply.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_imgputcomponentplyrsp` `/AWS1/CL_IMGPUTCOMPONENTPLYRSP`¶

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->putcomponentpolicy(
  iv_componentarn = |string|
  iv_policy = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_componentbuildversionar = lo_result->get_componentarn( ).
ENDIF.

/AWS1/IF_IMG=>PUTCOMPONENTPOLICY()¶