AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutComponentPolicy and EndPutComponentPolicy.

Namespace: Amazon.Imagebuilder
Assembly: AWSSDK.Imagebuilder.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<PutComponentPolicyResponse> PutComponentPolicyAsync(
         PutComponentPolicyRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Imagebuilder.Model.PutComponentPolicyRequest

Container for the necessary parameters to execute the PutComponentPolicy service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the PutComponentPolicy service method, as returned by Imagebuilder.

Exceptions

ExceptionCondition
CallRateLimitExceededException You have exceeded the permitted request rate for the specific operation.
ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ForbiddenException You are not authorized to perform the requested operation.
InvalidParameterValueException The value that you provided for the specified parameter is invalid.
InvalidRequestException You have requested an action that that the service doesn't support.
ResourceNotFoundException At least one of the resources referenced by your request does not exist.
ServiceException This exception is thrown when the service encounters an unrecoverable exception.
ServiceUnavailableException The service is unable to process your request at this time.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also