PutProjectPolicyRequest Class | AWS SDK for .NET V3

Container for the parameters to the PutProjectPolicy operation.

This operation applies only to Amazon Rekognition Custom Labels.

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project policy specifies that a trusted AWS account can copy a model version from a trusting AWS account to a project in the trusted AWS account. To copy a model version you use the CopyProjectVersion operation. Only applies to Custom Labels projects.

For more information about the format of a project policy document, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.

The response from PutProjectPolicy is a revision ID for the project policy. You can attach multiple project policies to a project. You can also update an existing project policy by specifying the policy revision ID of the existing policy.

To remove a project policy from a project, call DeleteProjectPolicy. To get a list of project policies attached to a project, call ListProjectPolicies.

You copy a model version by calling CopyProjectVersion.

This operation requires permissions to perform the rekognition:PutProjectPolicy action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.PutProjectPolicyRequest

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

Syntax

public class PutProjectPolicyRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The PutProjectPolicyRequest type exposes the following members

Constructors

	Name	Description
	PutProjectPolicyRequest()

Properties

Name	Type	Description
PolicyDocument	System.String	Gets and sets the property PolicyDocument. A resource policy to add to the model. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference.
PolicyName	System.String	Gets and sets the property PolicyName. A name for the policy.
PolicyRevisionId	System.String	Gets and sets the property PolicyRevisionId. The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels generates and assigns a new `PolicyRevisionId` and then deletes the previous version of the policy.
ProjectArn	System.String	Gets and sets the property ProjectArn. The Amazon Resource Name (ARN) of the project that the project policy is attached to.

Examples

This operation attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account.

PutProjectPolicy


var client = new AmazonRekognitionClient();
var response = client.PutProjectPolicy(new PutProjectPolicyRequest 
{
    PolicyDocument = "'{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"ALLOW\",\"Principal\":{\"AWS\":\"principal\"},\"Action\":\"rekognition:CopyProjectVersion\",\"Resource\":\"arn:aws:rekognition:us-east-1:123456789012:project/my-sdk-project/version/DestinationVersionName/1627045542080\"}]}'",
    PolicyName = "SamplePolicy",
    PolicyRevisionId = "0123456789abcdef",
    ProjectArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929"
});

string policyRevisionId = response.PolicyRevisionId;

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, 3.5