putGroupPolicy method

Future<void> putGroupPolicy({ required String groupName, required String policyDocument, required String policyName, })

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.

May throw LimitExceededException. May throw MalformedPolicyDocumentException. May throw NoSuchEntityException. May throw ServiceFailureException.

Parameter groupName : The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

Parameter policyDocument : The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

• Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
• The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
• The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Parameter policyName : The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Implementation

Future<void> putGroupPolicy({
  required String groupName,
  required String policyDocument,
  required String policyName,
}) async {
  ArgumentError.checkNotNull(groupName, 'groupName');
  _s.validateStringLength(
    'groupName',
    groupName,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(policyDocument, 'policyDocument');
  _s.validateStringLength(
    'policyDocument',
    policyDocument,
    1,
    131072,
    isRequired: true,
  );
  ArgumentError.checkNotNull(policyName, 'policyName');
  _s.validateStringLength(
    'policyName',
    policyName,
    1,
    128,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['GroupName'] = groupName;
  $request['PolicyDocument'] = policyDocument;
  $request['PolicyName'] = policyName;
  await _protocol.send(
    $request,
    action: 'PutGroupPolicy',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['PutGroupPolicyRequest'],
    shapes: shapes,
  );
}