Fix IamPolicy code example

[tkhill-AWS]

Describe the issue

The second code snippet in the Javadoc contains an error.

// IamClient requires a dependency on software.amazon.awssdk:iam
try (IamClient iam = IamClient.builder().region(Region.AWS_GLOBAL).build()) {
    String policyArn = "arn:aws:iam::123456789012:policy/AllowWriteBookMetadata";
    GetPolicyResponse getPolicyResponse = iam.getPolicy(r -> r.policyArn(policyArn));

    String policyVersion = getPolicyResponse.defaultVersionId();
    GetPolicyVersionResponse getPolicyVersionResponse =
        iam.getPolicyVersion(r -> r.policyArn(policyArn).versionId(policyVersion));

    IamPolicy policy = IamPolicy.fromJson(getPolicyVersionResponse.policyVersion().document());

    IamStatement newStatement = policy.statements().get(0).copy(s -> s.addAction("dynamodb:GetItem"));
    IamPolicy newPolicy = policy.copy(p -> p.statements(Arrays.asList(newStatement)));

    iam.createPolicy(r -> r.policyName("AllowReadWriteBookMetadata")
                           .policyDocument(newPolicy.toJson()));
}

The eighth line of the snippet:

IamPolicy policy = IamPolicy.fromJson(getPolicyVersionResponse.policyVersion().document());

does not work because getPolicyVersionResponse.policyVersion().document() returns a URL-encoded string.

I needed to change it to the following for the example to work:

            String decodedPolicy = URLDecoder.decode(getPolicyVersionResponse.policyVersion().document(), StandardCharsets.UTF_8);
            IamPolicy policy = IamPolicy.fromJson(decodedPolicy);

Links

https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/policybuilder/iam/IamPolicy.html

[debora-ito]

Hi Todd!

Thank you for reporting. We'll fix the docs.

[debora-ito]

Fixed via #4324, will be available in the next release.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.