util.arns
util.arns
See the examples under https://github.com/salesforce/policy_sentry/tree/master/examples/library-usage/util.
Functions to use for parsing ARNs, matching ARN types, and getting the right fragment/component from an ARN string,
ARN
Class that helps to match ARN resource type formats neatly
same_resource_type(self, arn_in_database)
Given an arn, see if it has the same resource type
Source code in policy_sentry/util/arns.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
|
does_arn_match(arn_to_test, arn_in_database)
Given two ARNs, determine if they have the same resource type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
arn_to_test |
|
ARN provided by user |
required |
arn_in_database |
|
Raw ARN that exists in the policy sentry database |
required |
Returns:
Type | Description |
---|---|
Boolean |
result of whether or not the ARNs match |
Source code in policy_sentry/util/arns.py
246 247 248 249 250 251 252 253 254 255 256 257 258 |
|
get_account_from_arn(arn)
Given an ARN, return the account ID in the ARN, if it is available. In certain cases like S3 it is not
Source code in policy_sentry/util/arns.py
193 194 195 196 197 198 199 200 201 |
|
get_region_from_arn(arn)
Given an ARN, return the region in the ARN, if it is available. In certain cases like S3 it is not
Source code in policy_sentry/util/arns.py
182 183 184 185 186 187 188 189 190 |
|
get_resource_path_from_arn(arn)
Given an ARN, parse it according to ARN namespacing and return the resource path. See http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html for more details on ARN namespacing.
Source code in policy_sentry/util/arns.py
204 205 206 207 208 |
|
get_resource_string(arn)
Given an ARN, return the string after the account ID, no matter the ARN format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
arn |
|
An ARN, like |
required |
Returns:
Type | Description |
---|---|
String |
The resource string, like |
Source code in policy_sentry/util/arns.py
211 212 213 214 215 216 217 218 219 220 221 222 |
|
get_service_from_arn(arn)
Given an ARN string, return the service
Source code in policy_sentry/util/arns.py
176 177 178 179 |
|
parse_arn(arn)
Given an ARN, split up the ARN into the ARN namespacing schema dictated by the AWS docs.
Source code in policy_sentry/util/arns.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
|
parse_arn_for_resource_type(arn)
Parses the resource string (resourcetype/resource and other variants) and grab the resource type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
arn |
|
The resource string to parse, like |
required |
Returns:
Type | Description |
---|---|
String |
The resource type, like |
Source code in policy_sentry/util/arns.py
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|