GetComponentPolicy - EC2 Image Builder

GetComponentPolicy

Gets a component policy.

Request Syntax

GET /GetComponentPolicy?componentArn=componentArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

componentArn

The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "policy": "string", "requestId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

policy

The component policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30000.

requestId

The request ID that uniquely identifies this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

InvalidRequestException

You have requested an action that that the service doesn't support.

HTTP Status Code: 400

ResourceNotFoundException

At least one of the resources referenced by your request does not exist.

HTTP Status Code: 404

ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: