put_component_policy

put_component_policy(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_component_policy(
    componentArn='string',
    policy='string'
)
Parameters
  • componentArn (string) --

    [REQUIRED]

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

  • policy (string) --

    [REQUIRED]

    The policy to apply.

Return type

dict

Returns

Response Syntax

{
    'requestId': 'string',
    'componentArn': 'string'
}

Response Structure

  • (dict) --

    • requestId (string) --

      The request ID that uniquely identifies this request.

    • componentArn (string) --

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

Exceptions

  • imagebuilder.Client.exceptions.ServiceException
  • imagebuilder.Client.exceptions.ClientException
  • imagebuilder.Client.exceptions.ServiceUnavailableException
  • imagebuilder.Client.exceptions.InvalidRequestException
  • imagebuilder.Client.exceptions.InvalidParameterValueException
  • imagebuilder.Client.exceptions.ResourceNotFoundException
  • imagebuilder.Client.exceptions.ForbiddenException
  • imagebuilder.Client.exceptions.CallRateLimitExceededException