Methods
getLatestPolicyDocument(policyName) → {object}
Get the latest policy document for a IAM Managed Policy by name
Parameters:
| Name | Type | Description |
|---|---|---|
policyName |
string |
The IAM Managed Policy name. |
Returns:
| Type | Description |
|---|---|
| object |
The IAM Managed Policy document if found. |
Throws:
Will throw an error if not found by the name.
getPolicyByName(policyName) → {object}
Get the IAM Managed Policy by name with the full version history
Parameters:
| Name | Type | Description |
|---|---|---|
policyName |
string |
The IAM Managed Policy name. |
Returns:
| Type | Description |
|---|---|
| object |
The IAM Managed Policy if found. |
Throws:
Will throw an error if not found by the name.
getPolicyCount() → {number}
Get the number of included IAM Managed Polcies.
Returns:
| Type | Description |
|---|---|
| number |
The count of IAM Managed Policies. |
getPolicyDiffByVersions(policyName, oldPolicyVersion, newPolicyVersion) → {object}
Get a diff of the policy documents for two versions of a IAM Managed Policy
Parameters:
| Name | Type | Description |
|---|---|---|
policyName |
string |
The IAM Managed Policy name. |
oldPolicyVersion |
number |
The old version id of the IAM Managed Policy. |
newPolicyVersion |
number |
The new version id of the IAM Managed Policy. |
Returns:
| Type | Description |
|---|---|
| object |
The diff of the IAM Managed Policy document versions if found. |
Throws:
Will throw an error if not found by the name or the respective policy document versions.
getPolicyDocumentByVersion(policyName, policyVersion) → {object}
Get the latest policy document for a IAM Managed Policy by name
Parameters:
| Name | Type | Description |
|---|---|---|
policyName |
string |
The IAM Managed Policy name. |
policyVersion |
number |
The version id of the IAM Managed Policy. |
Returns:
| Type | Description |
|---|---|
| object |
The IAM Managed Policy document if found. |
Throws:
Will throw an error if not found by the name.
listPolicies() → {Array}
Retrieve a list of all included IAM Managed Polcies.
Returns:
| Type | Description |
|---|---|
| Array |
An array of IAM Managed Policy names. |