imagebuilder / Client / put_container_recipe_policy

put_container_recipe_policy

imagebuilder.Client.put_container_recipe_policy(**kwargs)

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) 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_container_recipe_policy(
    containerRecipeArn='string',
    policy='string'
)

Parameters:

• containerRecipeArn (string) –

  [REQUIRED]

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

• policy (string) –

  [REQUIRED]

  The policy to apply to the container recipe.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'containerRecipeArn': 'string'
}

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • containerRecipeArn (string) –

    The Amazon Resource Name (ARN) of the container recipe 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