GetPolicy - Amazon CodeGuru Profiler

GetPolicy

Returns the JSON-formatted resource-based policy on a profiling group.

Request Syntax

GET /profilingGroups/profilingGroupName/policy HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

profilingGroupName

The name of the profiling group.

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

Pattern: ^[\w-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "policy": "string", "revisionId": "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 JSON-formatted resource-based policy attached to the ProfilingGroup.

Type: String

revisionId

A unique identifier for the current revision of the returned policy.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

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

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

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