github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/ram/2018-01-04/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p>This is the <i>Resource Access Manager API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts and within your organization or organizational units (OUs) in Organizations. For supported resource types, you can also share resources with IAM roles and IAM users. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts.</p> <p>To learn more about RAM, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/ram\">Resource Access Manager product page</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/\">Resource Access Manager User Guide</a> </p> </li> </ul>", 4 "operations": { 5 "AcceptResourceShareInvitation": "<p>Accepts an invitation to a resource share from another Amazon Web Services account.</p>", 6 "AssociateResourceShare": "<p>Associates the specified resource share with the specified principals and resources.</p>", 7 "AssociateResourceSharePermission": "<p>Associates a permission with a resource share.</p>", 8 "CreateResourceShare": "<p>Creates a resource share. You must provide a list of the Amazon Resource Names (ARNs) for the resources you want to share. You must also specify who you want to share the resources with, and the permissions that you grant them.</p> <note> <p>Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.</p> </note>", 9 "DeleteResourceShare": "<p>Deletes the specified resource share.</p>", 10 "DisassociateResourceShare": "<p>Disassociates the specified principals or resources from the specified resource share.</p>", 11 "DisassociateResourceSharePermission": "<p>Disassociates an RAM permission from a resource share.</p>", 12 "EnableSharingWithAwsOrganization": "<p>Enables resource sharing within your organization in Organizations.</p> <p>The caller must be the master account for the organization.</p>", 13 "GetPermission": "<p>Gets the contents of an RAM permission in JSON format.</p>", 14 "GetResourcePolicies": "<p>Gets the policies for the specified resources that you own and have shared.</p>", 15 "GetResourceShareAssociations": "<p>Gets the resources or principals for the resource shares that you own.</p>", 16 "GetResourceShareInvitations": "<p>Gets the invitations that you have received for resource shares.</p>", 17 "GetResourceShares": "<p>Gets the resource shares that you own or the resource shares that are shared with you.</p>", 18 "ListPendingInvitationResources": "<p>Lists the resources in a resource share that is shared with you but that the invitation is still pending for.</p>", 19 "ListPermissions": "<p>Lists the RAM permissions.</p>", 20 "ListPrincipals": "<p>Lists the principals that you have shared resources with or that have shared resources with you.</p>", 21 "ListResourceSharePermissions": "<p>Lists the RAM permissions that are associated with a resource share.</p>", 22 "ListResourceTypes": "<p>Lists the shareable resource types supported by RAM.</p>", 23 "ListResources": "<p>Lists the resources that you added to a resource shares or the resources that are shared with you.</p>", 24 "PromoteResourceShareCreatedFromPolicy": "<p>Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in RAM.</p> <p>Use this API action to promote the resource share. When you promote the resource share, it becomes:</p> <ul> <li> <p>Visible to all principals that it is shared with.</p> </li> <li> <p>Modifiable in RAM.</p> </li> </ul>", 25 "RejectResourceShareInvitation": "<p>Rejects an invitation to a resource share from another Amazon Web Services account.</p>", 26 "TagResource": "<p>Adds the specified tags to the specified resource share that you own.</p>", 27 "UntagResource": "<p>Removes the specified tags from the specified resource share that you own.</p>", 28 "UpdateResourceShare": "<p>Updates the specified resource share that you own.</p>" 29 }, 30 "shapes": { 31 "AcceptResourceShareInvitationRequest": { 32 "base": null, 33 "refs": { 34 } 35 }, 36 "AcceptResourceShareInvitationResponse": { 37 "base": null, 38 "refs": { 39 } 40 }, 41 "AssociateResourceSharePermissionRequest": { 42 "base": null, 43 "refs": { 44 } 45 }, 46 "AssociateResourceSharePermissionResponse": { 47 "base": null, 48 "refs": { 49 } 50 }, 51 "AssociateResourceShareRequest": { 52 "base": null, 53 "refs": { 54 } 55 }, 56 "AssociateResourceShareResponse": { 57 "base": null, 58 "refs": { 59 } 60 }, 61 "Boolean": { 62 "base": null, 63 "refs": { 64 "AssociateResourceSharePermissionRequest$replace": "<p>Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use <code>true</code> to replace the current permissions. Use <code>false</code> to add the permission to the current permission.</p>", 65 "AssociateResourceSharePermissionResponse$returnValue": "<p>Indicates whether the request succeeded.</p>", 66 "CreateResourceShareRequest$allowExternalPrincipals": "<p>Indicates whether principals outside your organization in Organizations can be associated with a resource share.</p>", 67 "DeleteResourceShareResponse$returnValue": "<p>Indicates whether the request succeeded.</p>", 68 "DisassociateResourceSharePermissionResponse$returnValue": "<p>Indicates whether the request succeeded.</p>", 69 "EnableSharingWithAwsOrganizationResponse$returnValue": "<p>Indicates whether the request succeeded.</p>", 70 "Principal$external": "<p>Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.</p>", 71 "PromoteResourceShareCreatedFromPolicyResponse$returnValue": "<p>Indicates whether the request succeeded.</p>", 72 "ResourceShare$allowExternalPrincipals": "<p>Indicates whether principals outside your organization in Organizations can be associated with a resource share.</p>", 73 "ResourceShareAssociation$external": "<p>Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.</p>", 74 "ResourceSharePermissionDetail$defaultVersion": "<p>Specifies whether the version of the permission is set to the default version for this permission.</p>", 75 "ResourceSharePermissionDetail$isResourceTypeDefault": "<p>Specifies whether the version of the permission is set to the default version for this resource type.</p>", 76 "ResourceSharePermissionSummary$defaultVersion": "<p>Specifies whether the version of the permission is set to the default version for this permission.</p>", 77 "ResourceSharePermissionSummary$isResourceTypeDefault": "<p>Specifies whether the version of the permission is set to the default version for this resource type.</p>", 78 "UpdateResourceShareRequest$allowExternalPrincipals": "<p>Indicates whether principals outside your organization in Organizations can be associated with a resource share.</p>" 79 } 80 }, 81 "CreateResourceShareRequest": { 82 "base": null, 83 "refs": { 84 } 85 }, 86 "CreateResourceShareResponse": { 87 "base": null, 88 "refs": { 89 } 90 }, 91 "DateTime": { 92 "base": null, 93 "refs": { 94 "Principal$creationTime": "<p>The time when the principal was associated with the resource share.</p>", 95 "Principal$lastUpdatedTime": "<p>The time when the association was last updated.</p>", 96 "Resource$creationTime": "<p>The time when the resource was associated with the resource share.</p>", 97 "Resource$lastUpdatedTime": "<p>The time when the association was last updated.</p>", 98 "ResourceShare$creationTime": "<p>The time when the resource share was created.</p>", 99 "ResourceShare$lastUpdatedTime": "<p>The time when the resource share was last updated.</p>", 100 "ResourceShareAssociation$creationTime": "<p>The time when the association was created.</p>", 101 "ResourceShareAssociation$lastUpdatedTime": "<p>The time when the association was last updated.</p>", 102 "ResourceShareInvitation$invitationTimestamp": "<p>The date and time when the invitation was sent.</p>", 103 "ResourceSharePermissionDetail$creationTime": "<p>The date and time when the permission was created.</p>", 104 "ResourceSharePermissionDetail$lastUpdatedTime": "<p>The date and time when the permission was last updated.</p>", 105 "ResourceSharePermissionSummary$creationTime": "<p>The date and time when the permission was created.</p>", 106 "ResourceSharePermissionSummary$lastUpdatedTime": "<p>The date and time when the permission was last updated.</p>" 107 } 108 }, 109 "DeleteResourceShareRequest": { 110 "base": null, 111 "refs": { 112 } 113 }, 114 "DeleteResourceShareResponse": { 115 "base": null, 116 "refs": { 117 } 118 }, 119 "DisassociateResourceSharePermissionRequest": { 120 "base": null, 121 "refs": { 122 } 123 }, 124 "DisassociateResourceSharePermissionResponse": { 125 "base": null, 126 "refs": { 127 } 128 }, 129 "DisassociateResourceShareRequest": { 130 "base": null, 131 "refs": { 132 } 133 }, 134 "DisassociateResourceShareResponse": { 135 "base": null, 136 "refs": { 137 } 138 }, 139 "EnableSharingWithAwsOrganizationRequest": { 140 "base": null, 141 "refs": { 142 } 143 }, 144 "EnableSharingWithAwsOrganizationResponse": { 145 "base": null, 146 "refs": { 147 } 148 }, 149 "GetPermissionRequest": { 150 "base": null, 151 "refs": { 152 } 153 }, 154 "GetPermissionResponse": { 155 "base": null, 156 "refs": { 157 } 158 }, 159 "GetResourcePoliciesRequest": { 160 "base": null, 161 "refs": { 162 } 163 }, 164 "GetResourcePoliciesResponse": { 165 "base": null, 166 "refs": { 167 } 168 }, 169 "GetResourceShareAssociationsRequest": { 170 "base": null, 171 "refs": { 172 } 173 }, 174 "GetResourceShareAssociationsResponse": { 175 "base": null, 176 "refs": { 177 } 178 }, 179 "GetResourceShareInvitationsRequest": { 180 "base": null, 181 "refs": { 182 } 183 }, 184 "GetResourceShareInvitationsResponse": { 185 "base": null, 186 "refs": { 187 } 188 }, 189 "GetResourceSharesRequest": { 190 "base": null, 191 "refs": { 192 } 193 }, 194 "GetResourceSharesResponse": { 195 "base": null, 196 "refs": { 197 } 198 }, 199 "IdempotentParameterMismatchException": { 200 "base": "<p>A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.</p>", 201 "refs": { 202 } 203 }, 204 "Integer": { 205 "base": null, 206 "refs": { 207 "AssociateResourceSharePermissionRequest$permissionVersion": "<p>The version of the RAM permissions to associate with the resource share.</p>", 208 "GetPermissionRequest$permissionVersion": "<p>The identifier for the version of the permission.</p>" 209 } 210 }, 211 "InvalidClientTokenException": { 212 "base": "<p>A client token is not valid.</p>", 213 "refs": { 214 } 215 }, 216 "InvalidMaxResultsException": { 217 "base": "<p>The specified value for MaxResults is not valid.</p>", 218 "refs": { 219 } 220 }, 221 "InvalidNextTokenException": { 222 "base": "<p>The specified value for NextToken is not valid.</p>", 223 "refs": { 224 } 225 }, 226 "InvalidParameterException": { 227 "base": "<p>A parameter is not valid.</p>", 228 "refs": { 229 } 230 }, 231 "InvalidResourceTypeException": { 232 "base": "<p>The specified resource type is not valid.</p>", 233 "refs": { 234 } 235 }, 236 "InvalidStateTransitionException": { 237 "base": "<p>The requested state transition is not valid.</p>", 238 "refs": { 239 } 240 }, 241 "ListPendingInvitationResourcesRequest": { 242 "base": null, 243 "refs": { 244 } 245 }, 246 "ListPendingInvitationResourcesResponse": { 247 "base": null, 248 "refs": { 249 } 250 }, 251 "ListPermissionsRequest": { 252 "base": null, 253 "refs": { 254 } 255 }, 256 "ListPermissionsResponse": { 257 "base": null, 258 "refs": { 259 } 260 }, 261 "ListPrincipalsRequest": { 262 "base": null, 263 "refs": { 264 } 265 }, 266 "ListPrincipalsResponse": { 267 "base": null, 268 "refs": { 269 } 270 }, 271 "ListResourceSharePermissionsRequest": { 272 "base": null, 273 "refs": { 274 } 275 }, 276 "ListResourceSharePermissionsResponse": { 277 "base": null, 278 "refs": { 279 } 280 }, 281 "ListResourceTypesRequest": { 282 "base": null, 283 "refs": { 284 } 285 }, 286 "ListResourceTypesResponse": { 287 "base": null, 288 "refs": { 289 } 290 }, 291 "ListResourcesRequest": { 292 "base": null, 293 "refs": { 294 } 295 }, 296 "ListResourcesResponse": { 297 "base": null, 298 "refs": { 299 } 300 }, 301 "MalformedArnException": { 302 "base": "<p>The format of an Amazon Resource Name (ARN) is not valid.</p>", 303 "refs": { 304 } 305 }, 306 "MaxResults": { 307 "base": null, 308 "refs": { 309 "GetResourcePoliciesRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 310 "GetResourceShareAssociationsRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 311 "GetResourceShareInvitationsRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 312 "GetResourceSharesRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 313 "ListPendingInvitationResourcesRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 314 "ListPermissionsRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 315 "ListPrincipalsRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 316 "ListResourceSharePermissionsRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 317 "ListResourceTypesRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>", 318 "ListResourcesRequest$maxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" 319 } 320 }, 321 "MissingRequiredParameterException": { 322 "base": "<p>A required input parameter is missing.</p>", 323 "refs": { 324 } 325 }, 326 "OperationNotPermittedException": { 327 "base": "<p>The requested operation is not permitted.</p>", 328 "refs": { 329 } 330 }, 331 "PermissionArnList": { 332 "base": null, 333 "refs": { 334 "CreateResourceShareRequest$permissionArns": "<p>The Amazon Resource Names (ARNs) of the permissions to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. Only one permission can be associated with each resource type in a resource share.</p>" 335 } 336 }, 337 "Policy": { 338 "base": null, 339 "refs": { 340 "PolicyList$member": null 341 } 342 }, 343 "PolicyList": { 344 "base": null, 345 "refs": { 346 "GetResourcePoliciesResponse$policies": "<p>A key policy document, in JSON format.</p>" 347 } 348 }, 349 "Principal": { 350 "base": "<p>Describes a principal for use with Resource Access Manager.</p>", 351 "refs": { 352 "PrincipalList$member": null 353 } 354 }, 355 "PrincipalArnOrIdList": { 356 "base": null, 357 "refs": { 358 "AssociateResourceShareRequest$principals": "<p>The principals to associate with the resource share. The possible values are:</p> <ul> <li> <p>An Amazon Web Services account ID</p> </li> <li> <p>An Amazon Resource Name (ARN) of an organization in Organizations</p> </li> <li> <p>An ARN of an organizational unit (OU) in Organizations</p> </li> <li> <p>An ARN of an IAM role</p> </li> <li> <p>An ARN of an IAM user</p> </li> </ul> <note> <p>Not all resource types can be shared with IAM roles and IAM users. For more information, see <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types\">Sharing with IAM roles and IAM users</a> in the <i>Resource Access Manager User Guide</i>.</p> </note>", 359 "CreateResourceShareRequest$principals": "<p>The principals to associate with the resource share. The possible values are:</p> <ul> <li> <p>An Amazon Web Services account ID</p> </li> <li> <p>An Amazon Resource Name (ARN) of an organization in Organizations</p> </li> <li> <p>An ARN of an organizational unit (OU) in Organizations</p> </li> <li> <p>An ARN of an IAM role</p> </li> <li> <p>An ARN of an IAM user</p> </li> </ul> <note> <p>Not all resource types can be shared with IAM roles and IAM users. For more information, see <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types\">Sharing with IAM roles and IAM users</a> in the <i>Resource Access Manager User Guide</i>.</p> </note>", 360 "DisassociateResourceShareRequest$principals": "<p>The principals.</p>", 361 "ListPrincipalsRequest$principals": "<p>The principals.</p>" 362 } 363 }, 364 "PrincipalList": { 365 "base": null, 366 "refs": { 367 "ListPrincipalsResponse$principals": "<p>The principals.</p>" 368 } 369 }, 370 "PromoteResourceShareCreatedFromPolicyRequest": { 371 "base": null, 372 "refs": { 373 } 374 }, 375 "PromoteResourceShareCreatedFromPolicyResponse": { 376 "base": null, 377 "refs": { 378 } 379 }, 380 "RejectResourceShareInvitationRequest": { 381 "base": null, 382 "refs": { 383 } 384 }, 385 "RejectResourceShareInvitationResponse": { 386 "base": null, 387 "refs": { 388 } 389 }, 390 "Resource": { 391 "base": "<p>Describes a resource associated with a resource share.</p>", 392 "refs": { 393 "ResourceList$member": null 394 } 395 }, 396 "ResourceArnList": { 397 "base": null, 398 "refs": { 399 "AssociateResourceShareRequest$resourceArns": "<p>The Amazon Resource Names (ARNs) of the resources.</p>", 400 "CreateResourceShareRequest$resourceArns": "<p>The ARNs of the resources to associate with the resource share.</p>", 401 "DisassociateResourceShareRequest$resourceArns": "<p>The Amazon Resource Names (ARNs) of the resources.</p>", 402 "GetResourcePoliciesRequest$resourceArns": "<p>The Amazon Resource Names (ARNs) of the resources.</p>", 403 "ListResourcesRequest$resourceArns": "<p>The Amazon Resource Names (ARNs) of the resources.</p>" 404 } 405 }, 406 "ResourceArnNotFoundException": { 407 "base": "<p>An Amazon Resource Name (ARN) was not found.</p>", 408 "refs": { 409 } 410 }, 411 "ResourceList": { 412 "base": null, 413 "refs": { 414 "ListPendingInvitationResourcesResponse$resources": "<p>Information about the resources included the resource share.</p>", 415 "ListResourcesResponse$resources": "<p>Information about the resources.</p>" 416 } 417 }, 418 "ResourceOwner": { 419 "base": null, 420 "refs": { 421 "GetResourceSharesRequest$resourceOwner": "<p>The type of owner.</p>", 422 "ListPrincipalsRequest$resourceOwner": "<p>The type of owner.</p>", 423 "ListResourcesRequest$resourceOwner": "<p>The type of owner.</p>" 424 } 425 }, 426 "ResourceShare": { 427 "base": "<p>Describes a resource share.</p>", 428 "refs": { 429 "CreateResourceShareResponse$resourceShare": "<p>Information about the resource share.</p>", 430 "ResourceShareList$member": null, 431 "UpdateResourceShareResponse$resourceShare": "<p>Information about the resource share.</p>" 432 } 433 }, 434 "ResourceShareArnList": { 435 "base": null, 436 "refs": { 437 "GetResourceShareAssociationsRequest$resourceShareArns": "<p>The Amazon Resource Names (ARN) of the resource shares.</p>", 438 "GetResourceShareInvitationsRequest$resourceShareArns": "<p>The Amazon Resource Names (ARN) of the resource shares.</p>", 439 "GetResourceSharesRequest$resourceShareArns": "<p>The Amazon Resource Names (ARNs) of the resource shares.</p>", 440 "ListPrincipalsRequest$resourceShareArns": "<p>The Amazon Resource Names (ARN) of the resource shares.</p>", 441 "ListResourcesRequest$resourceShareArns": "<p>The Amazon Resource Names (ARN) of the resource shares.</p>" 442 } 443 }, 444 "ResourceShareAssociation": { 445 "base": "<p>Describes an association with a resource share.</p>", 446 "refs": { 447 "ResourceShareAssociationList$member": null 448 } 449 }, 450 "ResourceShareAssociationList": { 451 "base": null, 452 "refs": { 453 "AssociateResourceShareResponse$resourceShareAssociations": "<p>Information about the associations.</p>", 454 "DisassociateResourceShareResponse$resourceShareAssociations": "<p>Information about the associations.</p>", 455 "GetResourceShareAssociationsResponse$resourceShareAssociations": "<p>Information about the associations.</p>", 456 "ResourceShareInvitation$resourceShareAssociations": "<p>To view the resources associated with a pending resource share invitation, use <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html\"> ListPendingInvitationResources</a>.</p>" 457 } 458 }, 459 "ResourceShareAssociationStatus": { 460 "base": null, 461 "refs": { 462 "GetResourceShareAssociationsRequest$associationStatus": "<p>The association status.</p>", 463 "ResourceShareAssociation$status": "<p>The status of the association.</p>" 464 } 465 }, 466 "ResourceShareAssociationType": { 467 "base": null, 468 "refs": { 469 "GetResourceShareAssociationsRequest$associationType": "<p>The association type. Specify <code>PRINCIPAL</code> to list the principals that are associated with the specified resource share. Specify <code>RESOURCE</code> to list the resources that are associated with the specified resource share.</p>", 470 "ResourceShareAssociation$associationType": "<p>The association type.</p>" 471 } 472 }, 473 "ResourceShareFeatureSet": { 474 "base": null, 475 "refs": { 476 "ResourceShare$featureSet": "<p>Indicates how the resource share was created. Possible values include:</p> <ul> <li> <p> <code>CREATED_FROM_POLICY</code> - Indicates that the resource share was created from an Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.</p> </li> <li> <p> <code>PROMOTING_TO_STANDARD</code> - The resource share is in the process of being promoted. For more information, see <a>PromoteResourceShareCreatedFromPolicy</a>.</p> </li> <li> <p> <code>STANDARD</code> - Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in RAM.</p> </li> </ul>" 477 } 478 }, 479 "ResourceShareInvitation": { 480 "base": "<p>Describes an invitation to join a resource share.</p>", 481 "refs": { 482 "AcceptResourceShareInvitationResponse$resourceShareInvitation": "<p>Information about the invitation.</p>", 483 "RejectResourceShareInvitationResponse$resourceShareInvitation": "<p>Information about the invitation.</p>", 484 "ResourceShareInvitationList$member": null 485 } 486 }, 487 "ResourceShareInvitationAlreadyAcceptedException": { 488 "base": "<p>The invitation was already accepted.</p>", 489 "refs": { 490 } 491 }, 492 "ResourceShareInvitationAlreadyRejectedException": { 493 "base": "<p>The invitation was already rejected.</p>", 494 "refs": { 495 } 496 }, 497 "ResourceShareInvitationArnList": { 498 "base": null, 499 "refs": { 500 "GetResourceShareInvitationsRequest$resourceShareInvitationArns": "<p>The Amazon Resource Names (ARN) of the invitations.</p>" 501 } 502 }, 503 "ResourceShareInvitationArnNotFoundException": { 504 "base": "<p>The Amazon Resource Name (ARN) for an invitation was not found.</p>", 505 "refs": { 506 } 507 }, 508 "ResourceShareInvitationExpiredException": { 509 "base": "<p>The invitation is expired.</p>", 510 "refs": { 511 } 512 }, 513 "ResourceShareInvitationList": { 514 "base": null, 515 "refs": { 516 "GetResourceShareInvitationsResponse$resourceShareInvitations": "<p>Information about the invitations.</p>" 517 } 518 }, 519 "ResourceShareInvitationStatus": { 520 "base": null, 521 "refs": { 522 "ResourceShareInvitation$status": "<p>The status of the invitation.</p>" 523 } 524 }, 525 "ResourceShareLimitExceededException": { 526 "base": "<p>The requested resource share exceeds the limit for your account.</p>", 527 "refs": { 528 } 529 }, 530 "ResourceShareList": { 531 "base": null, 532 "refs": { 533 "GetResourceSharesResponse$resourceShares": "<p>Information about the resource shares.</p>" 534 } 535 }, 536 "ResourceSharePermissionDetail": { 537 "base": "<p>Information about an RAM permission.</p>", 538 "refs": { 539 "GetPermissionResponse$permission": "<p>Information about the permission.</p>" 540 } 541 }, 542 "ResourceSharePermissionList": { 543 "base": null, 544 "refs": { 545 "ListPermissionsResponse$permissions": "<p>Information about the permissions.</p>", 546 "ListResourceSharePermissionsResponse$permissions": "<p>The permissions associated with the resource share.</p>" 547 } 548 }, 549 "ResourceSharePermissionSummary": { 550 "base": "<p>Information about a permission that is associated with a resource share.</p>", 551 "refs": { 552 "ResourceSharePermissionList$member": null 553 } 554 }, 555 "ResourceShareStatus": { 556 "base": null, 557 "refs": { 558 "GetResourceSharesRequest$resourceShareStatus": "<p>The status of the resource share.</p>", 559 "ResourceShare$status": "<p>The status of the resource share.</p>" 560 } 561 }, 562 "ResourceStatus": { 563 "base": null, 564 "refs": { 565 "Resource$status": "<p>The status of the resource.</p>" 566 } 567 }, 568 "ServerInternalException": { 569 "base": "<p>The service could not respond to the request due to an internal problem.</p>", 570 "refs": { 571 } 572 }, 573 "ServiceNameAndResourceType": { 574 "base": "<p>Information about the shareable resource types and the Amazon Web Services services to which they belong.</p>", 575 "refs": { 576 "ServiceNameAndResourceTypeList$member": null 577 } 578 }, 579 "ServiceNameAndResourceTypeList": { 580 "base": null, 581 "refs": { 582 "ListResourceTypesResponse$resourceTypes": "<p>The shareable resource types supported by RAM.</p>" 583 } 584 }, 585 "ServiceUnavailableException": { 586 "base": "<p>The service is not available.</p>", 587 "refs": { 588 } 589 }, 590 "String": { 591 "base": null, 592 "refs": { 593 "AcceptResourceShareInvitationRequest$resourceShareInvitationArn": "<p>The Amazon Resource Name (ARN) of the invitation.</p>", 594 "AcceptResourceShareInvitationRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 595 "AcceptResourceShareInvitationResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 596 "AssociateResourceSharePermissionRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 597 "AssociateResourceSharePermissionRequest$permissionArn": "<p>The Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.</p>", 598 "AssociateResourceSharePermissionRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 599 "AssociateResourceSharePermissionResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 600 "AssociateResourceShareRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 601 "AssociateResourceShareRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 602 "AssociateResourceShareResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 603 "CreateResourceShareRequest$name": "<p>The name of the resource share.</p>", 604 "CreateResourceShareRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 605 "CreateResourceShareResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 606 "DeleteResourceShareRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 607 "DeleteResourceShareRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 608 "DeleteResourceShareResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 609 "DisassociateResourceSharePermissionRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 610 "DisassociateResourceSharePermissionRequest$permissionArn": "<p>The Amazon Resource Name (ARN) of the permission to disassociate from the resource share.</p>", 611 "DisassociateResourceSharePermissionRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 612 "DisassociateResourceSharePermissionResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 613 "DisassociateResourceShareRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 614 "DisassociateResourceShareRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 615 "DisassociateResourceShareResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 616 "GetPermissionRequest$permissionArn": "<p>The Amazon Resource Name (ARN) of the permission.</p>", 617 "GetResourcePoliciesRequest$principal": "<p>The principal.</p>", 618 "GetResourcePoliciesRequest$nextToken": "<p>The token for the next page of results.</p>", 619 "GetResourcePoliciesResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 620 "GetResourceShareAssociationsRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is <code>PRINCIPAL</code>.</p>", 621 "GetResourceShareAssociationsRequest$principal": "<p>The principal. You cannot specify this parameter if the association type is <code>RESOURCE</code>.</p>", 622 "GetResourceShareAssociationsRequest$nextToken": "<p>The token for the next page of results.</p>", 623 "GetResourceShareAssociationsResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 624 "GetResourceShareInvitationsRequest$nextToken": "<p>The token for the next page of results.</p>", 625 "GetResourceShareInvitationsResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 626 "GetResourceSharesRequest$name": "<p>The name of the resource share.</p>", 627 "GetResourceSharesRequest$nextToken": "<p>The token for the next page of results.</p>", 628 "GetResourceSharesRequest$permissionArn": "<p>The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.</p>", 629 "GetResourceSharesResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 630 "IdempotentParameterMismatchException$message": null, 631 "InvalidClientTokenException$message": null, 632 "InvalidMaxResultsException$message": null, 633 "InvalidNextTokenException$message": null, 634 "InvalidParameterException$message": null, 635 "InvalidResourceTypeException$message": null, 636 "InvalidStateTransitionException$message": null, 637 "ListPendingInvitationResourcesRequest$resourceShareInvitationArn": "<p>The Amazon Resource Name (ARN) of the invitation.</p>", 638 "ListPendingInvitationResourcesRequest$nextToken": "<p>The token for the next page of results.</p>", 639 "ListPendingInvitationResourcesResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 640 "ListPermissionsRequest$resourceType": "<p>Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify <code>ec2:Subnet</code>.</p>", 641 "ListPermissionsRequest$nextToken": "<p>The token for the next page of results.</p>", 642 "ListPermissionsResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 643 "ListPrincipalsRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 644 "ListPrincipalsRequest$resourceType": "<p>The resource type.</p> <p>Valid values: <code>acm-pca:CertificateAuthority</code> | <code>appmesh:Mesh</code> | <code>codebuild:Project</code> | <code>codebuild:ReportGroup</code> | <code>ec2:CapacityReservation</code> | <code>ec2:DedicatedHost</code> | <code>ec2:LocalGatewayRouteTable</code> | <code>ec2:PrefixList</code> | <code>ec2:Subnet</code> | <code>ec2:TrafficMirrorTarget</code> | <code>ec2:TransitGateway</code> | <code>imagebuilder:Component</code> | <code>imagebuilder:Image</code> | <code>imagebuilder:ImageRecipe</code> | <code>imagebuilder:ContainerRecipe</code> | <code>glue:Catalog</code> | <code>glue:Database</code> | <code>glue:Table</code> | <code>license-manager:LicenseConfiguration</code> I <code>network-firewall:FirewallPolicy</code> | <code>network-firewall:StatefulRuleGroup</code> | <code>network-firewall:StatelessRuleGroup</code> | <code>outposts:Outpost</code> | <code>resource-groups:Group</code> | <code>rds:Cluster</code> | <code>route53resolver:FirewallRuleGroup</code> |<code>route53resolver:ResolverQueryLogConfig</code> | <code>route53resolver:ResolverRule</code> | <code>s3-outposts:Outpost</code> | <code>ssm-contacts:Contact</code> | <code>ssm-incidents:ResponsePlan</code> </p>", 645 "ListPrincipalsRequest$nextToken": "<p>The token for the next page of results.</p>", 646 "ListPrincipalsResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 647 "ListResourceSharePermissionsRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 648 "ListResourceSharePermissionsRequest$nextToken": "<p>The token for the next page of results.</p>", 649 "ListResourceSharePermissionsResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 650 "ListResourceTypesRequest$nextToken": "<p>The token for the next page of results.</p>", 651 "ListResourceTypesResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 652 "ListResourcesRequest$principal": "<p>The principal.</p>", 653 "ListResourcesRequest$resourceType": "<p>The resource type.</p> <p>Valid values: <code>acm-pca:CertificateAuthority</code> | <code>appmesh:Mesh</code> | <code>codebuild:Project</code> | <code>codebuild:ReportGroup</code> | <code>ec2:CapacityReservation</code> | <code>ec2:DedicatedHost</code> | <code>ec2:LocalGatewayRouteTable</code> | <code>ec2:PrefixList</code> | <code>ec2:Subnet</code> | <code>ec2:TrafficMirrorTarget</code> | <code>ec2:TransitGateway</code> | <code>imagebuilder:Component</code> | <code>imagebuilder:Image</code> | <code>imagebuilder:ImageRecipe</code> | <code>imagebuilder:ContainerRecipe</code> | <code>glue:Catalog</code> | <code>glue:Database</code> | <code>glue:Table</code> | <code>license-manager:LicenseConfiguration</code> I <code>network-firewall:FirewallPolicy</code> | <code>network-firewall:StatefulRuleGroup</code> | <code>network-firewall:StatelessRuleGroup</code> | <code>outposts:Outpost</code> | <code>resource-groups:Group</code> | <code>rds:Cluster</code> | <code>route53resolver:FirewallRuleGroup</code> |<code>route53resolver:ResolverQueryLogConfig</code> | <code>route53resolver:ResolverRule</code> | <code>s3-outposts:Outpost</code> | <code>ssm-contacts:Contact</code> | <code>ssm-incidents:ResponsePlan</code> </p>", 654 "ListResourcesRequest$nextToken": "<p>The token for the next page of results.</p>", 655 "ListResourcesResponse$nextToken": "<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>", 656 "MalformedArnException$message": null, 657 "MissingRequiredParameterException$message": null, 658 "OperationNotPermittedException$message": null, 659 "PermissionArnList$member": null, 660 "Principal$id": "<p>The ID of the principal.</p>", 661 "Principal$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 662 "PrincipalArnOrIdList$member": null, 663 "PromoteResourceShareCreatedFromPolicyRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share to promote.</p>", 664 "RejectResourceShareInvitationRequest$resourceShareInvitationArn": "<p>The Amazon Resource Name (ARN) of the invitation.</p>", 665 "RejectResourceShareInvitationRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 666 "RejectResourceShareInvitationResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 667 "Resource$arn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 668 "Resource$type": "<p>The resource type.</p>", 669 "Resource$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 670 "Resource$resourceGroupArn": "<p>The Amazon Resource Name (ARN) of the resource group. This value is returned only if the resource is a resource group.</p>", 671 "Resource$statusMessage": "<p>A message about the status of the resource.</p>", 672 "ResourceArnList$member": null, 673 "ResourceArnNotFoundException$message": null, 674 "ResourceShare$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 675 "ResourceShare$name": "<p>The name of the resource share.</p>", 676 "ResourceShare$owningAccountId": "<p>The ID of the Amazon Web Services account that owns the resource share.</p>", 677 "ResourceShare$statusMessage": "<p>A message about the status of the resource share.</p>", 678 "ResourceShareArnList$member": null, 679 "ResourceShareAssociation$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 680 "ResourceShareAssociation$resourceShareName": "<p>The name of the resource share.</p>", 681 "ResourceShareAssociation$associatedEntity": "<p>The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:</p> <ul> <li> <p>An Amazon Web Services account ID</p> </li> <li> <p>An ARN of an organization in Organizations</p> </li> <li> <p>An ARN of an organizational unit (OU) in Organizations</p> </li> <li> <p>An ARN of an IAM role</p> </li> <li> <p>An ARN of an IAM user</p> </li> </ul>", 682 "ResourceShareAssociation$statusMessage": "<p>A message about the status of the association.</p>", 683 "ResourceShareInvitation$resourceShareInvitationArn": "<p>The Amazon Resource Name (ARN) of the invitation.</p>", 684 "ResourceShareInvitation$resourceShareName": "<p>The name of the resource share.</p>", 685 "ResourceShareInvitation$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 686 "ResourceShareInvitation$senderAccountId": "<p>The ID of the Amazon Web Services account that sent the invitation.</p>", 687 "ResourceShareInvitation$receiverAccountId": "<p>The ID of the Amazon Web Services account that received the invitation.</p>", 688 "ResourceShareInvitation$receiverArn": "<p>The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.</p>", 689 "ResourceShareInvitationAlreadyAcceptedException$message": null, 690 "ResourceShareInvitationAlreadyRejectedException$message": null, 691 "ResourceShareInvitationArnList$member": null, 692 "ResourceShareInvitationArnNotFoundException$message": null, 693 "ResourceShareInvitationExpiredException$message": null, 694 "ResourceShareLimitExceededException$message": null, 695 "ResourceSharePermissionDetail$arn": "<p>The Amazon Resource Name (ARN) of the permission.</p>", 696 "ResourceSharePermissionDetail$version": "<p>The identifier for the version of the permission.</p>", 697 "ResourceSharePermissionDetail$name": "<p>The name of the permission.</p>", 698 "ResourceSharePermissionDetail$resourceType": "<p>The resource type to which the permission applies.</p>", 699 "ResourceSharePermissionDetail$permission": "<p>The permission's effect and actions in JSON format. The <code>effect</code> indicates whether the actions are allowed or denied. The <code>actions</code> list the API actions to which the principal is granted or denied access.</p>", 700 "ResourceSharePermissionSummary$arn": "<p>The Amazon Resource Name (ARN) of the permission.</p>", 701 "ResourceSharePermissionSummary$version": "<p>The identifier for the version of the permission.</p>", 702 "ResourceSharePermissionSummary$name": "<p>The name of the permission.</p>", 703 "ResourceSharePermissionSummary$resourceType": "<p>The type of resource to which the permission applies.</p>", 704 "ResourceSharePermissionSummary$status": "<p>The current status of the permission.</p>", 705 "ServerInternalException$message": null, 706 "ServiceNameAndResourceType$resourceType": "<p>The shareable resource types.</p>", 707 "ServiceNameAndResourceType$serviceName": "<p>The name of the Amazon Web Services services to which the resources belong.</p>", 708 "ServiceUnavailableException$message": null, 709 "TagLimitExceededException$message": null, 710 "TagPolicyViolationException$message": null, 711 "TagResourceRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 712 "UnknownResourceException$message": null, 713 "UntagResourceRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 714 "UpdateResourceShareRequest$resourceShareArn": "<p>The Amazon Resource Name (ARN) of the resource share.</p>", 715 "UpdateResourceShareRequest$name": "<p>The name of the resource share.</p>", 716 "UpdateResourceShareRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 717 "UpdateResourceShareResponse$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" 718 } 719 }, 720 "Tag": { 721 "base": "<p>Information about a tag.</p>", 722 "refs": { 723 "TagList$member": null 724 } 725 }, 726 "TagFilter": { 727 "base": "<p>Used to filter information based on tags.</p>", 728 "refs": { 729 "TagFilters$member": null 730 } 731 }, 732 "TagFilters": { 733 "base": null, 734 "refs": { 735 "GetResourceSharesRequest$tagFilters": "<p>One or more tag filters.</p>" 736 } 737 }, 738 "TagKey": { 739 "base": null, 740 "refs": { 741 "Tag$key": "<p>The key of the tag.</p>", 742 "TagFilter$tagKey": "<p>The tag key.</p>", 743 "TagKeyList$member": null 744 } 745 }, 746 "TagKeyList": { 747 "base": null, 748 "refs": { 749 "UntagResourceRequest$tagKeys": "<p>The tag keys of the tags to remove.</p>" 750 } 751 }, 752 "TagLimitExceededException": { 753 "base": "<p>The requested tags exceed the limit for your account.</p>", 754 "refs": { 755 } 756 }, 757 "TagList": { 758 "base": null, 759 "refs": { 760 "CreateResourceShareRequest$tags": "<p>One or more tags.</p>", 761 "ResourceShare$tags": "<p>The tags for the resource share.</p>", 762 "TagResourceRequest$tags": "<p>One or more tags.</p>" 763 } 764 }, 765 "TagPolicyViolationException": { 766 "base": "<p>The specified tag is a reserved word and cannot be used.</p>", 767 "refs": { 768 } 769 }, 770 "TagResourceRequest": { 771 "base": null, 772 "refs": { 773 } 774 }, 775 "TagResourceResponse": { 776 "base": null, 777 "refs": { 778 } 779 }, 780 "TagValue": { 781 "base": null, 782 "refs": { 783 "Tag$value": "<p>The value of the tag.</p>", 784 "TagValueList$member": null 785 } 786 }, 787 "TagValueList": { 788 "base": null, 789 "refs": { 790 "TagFilter$tagValues": "<p>The tag values.</p>" 791 } 792 }, 793 "UnknownResourceException": { 794 "base": "<p>A specified resource was not found.</p>", 795 "refs": { 796 } 797 }, 798 "UntagResourceRequest": { 799 "base": null, 800 "refs": { 801 } 802 }, 803 "UntagResourceResponse": { 804 "base": null, 805 "refs": { 806 } 807 }, 808 "UpdateResourceShareRequest": { 809 "base": null, 810 "refs": { 811 } 812 }, 813 "UpdateResourceShareResponse": { 814 "base": null, 815 "refs": { 816 } 817 } 818 } 819 }