@aws-sdk/client-ram 3.315.0 → 3.316.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/README.md +76 -5
  2. package/dist-cjs/RAM.js +47 -350
  3. package/dist-cjs/commands/CreatePermissionCommand.js +45 -0
  4. package/dist-cjs/commands/CreatePermissionVersionCommand.js +45 -0
  5. package/dist-cjs/commands/DeletePermissionCommand.js +45 -0
  6. package/dist-cjs/commands/DeletePermissionVersionCommand.js +45 -0
  7. package/dist-cjs/commands/ListPermissionAssociationsCommand.js +45 -0
  8. package/dist-cjs/commands/ListReplacePermissionAssociationsWorkCommand.js +45 -0
  9. package/dist-cjs/commands/PromotePermissionCreatedFromPolicyCommand.js +45 -0
  10. package/dist-cjs/commands/ReplacePermissionAssociationsCommand.js +45 -0
  11. package/dist-cjs/commands/SetDefaultPermissionVersionCommand.js +45 -0
  12. package/dist-cjs/commands/index.js +9 -0
  13. package/dist-cjs/endpoint/ruleset.js +3 -3
  14. package/dist-cjs/models/models_0.js +104 -1
  15. package/dist-cjs/pagination/ListPermissionAssociationsPaginator.js +29 -0
  16. package/dist-cjs/pagination/ListReplacePermissionAssociationsWorkPaginator.js +29 -0
  17. package/dist-cjs/pagination/index.js +2 -0
  18. package/dist-cjs/protocols/Aws_restJson1.js +976 -129
  19. package/dist-es/RAM.js +47 -350
  20. package/dist-es/commands/CreatePermissionCommand.js +41 -0
  21. package/dist-es/commands/CreatePermissionVersionCommand.js +41 -0
  22. package/dist-es/commands/DeletePermissionCommand.js +41 -0
  23. package/dist-es/commands/DeletePermissionVersionCommand.js +41 -0
  24. package/dist-es/commands/ListPermissionAssociationsCommand.js +41 -0
  25. package/dist-es/commands/ListReplacePermissionAssociationsWorkCommand.js +41 -0
  26. package/dist-es/commands/PromotePermissionCreatedFromPolicyCommand.js +41 -0
  27. package/dist-es/commands/ReplacePermissionAssociationsCommand.js +41 -0
  28. package/dist-es/commands/SetDefaultPermissionVersionCommand.js +41 -0
  29. package/dist-es/commands/index.js +9 -0
  30. package/dist-es/endpoint/ruleset.js +3 -3
  31. package/dist-es/models/models_0.js +97 -0
  32. package/dist-es/pagination/ListPermissionAssociationsPaginator.js +25 -0
  33. package/dist-es/pagination/ListReplacePermissionAssociationsWorkPaginator.js +25 -0
  34. package/dist-es/pagination/index.js +2 -0
  35. package/dist-es/protocols/Aws_restJson1.js +949 -121
  36. package/dist-types/RAM.d.ts +114 -113
  37. package/dist-types/RAMClient.d.ts +15 -7
  38. package/dist-types/commands/AcceptResourceShareInvitationCommand.d.ts +16 -12
  39. package/dist-types/commands/AssociateResourceShareCommand.d.ts +19 -14
  40. package/dist-types/commands/AssociateResourceSharePermissionCommand.d.ts +9 -7
  41. package/dist-types/commands/CreatePermissionCommand.d.ts +109 -0
  42. package/dist-types/commands/CreatePermissionVersionCommand.d.ts +106 -0
  43. package/dist-types/commands/CreateResourceShareCommand.d.ts +19 -13
  44. package/dist-types/commands/DeletePermissionCommand.d.ts +91 -0
  45. package/dist-types/commands/DeletePermissionVersionCommand.d.ts +96 -0
  46. package/dist-types/commands/DeleteResourceShareCommand.d.ts +19 -14
  47. package/dist-types/commands/DisassociateResourceShareCommand.d.ts +19 -13
  48. package/dist-types/commands/DisassociateResourceSharePermissionCommand.d.ts +14 -11
  49. package/dist-types/commands/EnableSharingWithAwsOrganizationCommand.d.ts +14 -11
  50. package/dist-types/commands/GetPermissionCommand.d.ts +9 -7
  51. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +10 -6
  52. package/dist-types/commands/GetResourceShareAssociationsCommand.d.ts +13 -8
  53. package/dist-types/commands/GetResourceShareInvitationsCommand.d.ts +14 -8
  54. package/dist-types/commands/GetResourceSharesCommand.d.ts +11 -6
  55. package/dist-types/commands/ListPendingInvitationResourcesCommand.d.ts +15 -9
  56. package/dist-types/commands/ListPermissionAssociationsCommand.d.ts +91 -0
  57. package/dist-types/commands/ListPermissionVersionsCommand.d.ts +11 -7
  58. package/dist-types/commands/ListPermissionsCommand.d.ts +9 -5
  59. package/dist-types/commands/ListPrincipalsCommand.d.ts +10 -6
  60. package/dist-types/commands/ListReplacePermissionAssociationsWorkCommand.d.ts +84 -0
  61. package/dist-types/commands/ListResourceSharePermissionsCommand.d.ts +11 -7
  62. package/dist-types/commands/ListResourceTypesCommand.d.ts +7 -4
  63. package/dist-types/commands/ListResourcesCommand.d.ts +11 -7
  64. package/dist-types/commands/PromotePermissionCreatedFromPolicyCommand.d.ts +119 -0
  65. package/dist-types/commands/PromoteResourceShareCreatedFromPolicyCommand.d.ts +34 -14
  66. package/dist-types/commands/RejectResourceShareInvitationCommand.d.ts +16 -12
  67. package/dist-types/commands/ReplacePermissionAssociationsCommand.d.ts +108 -0
  68. package/dist-types/commands/SetDefaultPermissionVersionCommand.d.ts +92 -0
  69. package/dist-types/commands/TagResourceCommand.d.ts +17 -11
  70. package/dist-types/commands/UntagResourceCommand.d.ts +14 -5
  71. package/dist-types/commands/UpdateResourceShareCommand.d.ts +13 -11
  72. package/dist-types/commands/index.d.ts +9 -0
  73. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  74. package/dist-types/models/models_0.d.ts +1286 -195
  75. package/dist-types/pagination/ListPermissionAssociationsPaginator.d.ts +7 -0
  76. package/dist-types/pagination/ListReplacePermissionAssociationsWorkPaginator.d.ts +7 -0
  77. package/dist-types/pagination/index.d.ts +2 -0
  78. package/dist-types/protocols/Aws_restJson1.d.ts +81 -0
  79. package/dist-types/ts3.4/RAM.d.ts +167 -1
  80. package/dist-types/ts3.4/RAMClient.d.ts +54 -0
  81. package/dist-types/ts3.4/commands/CreatePermissionCommand.d.ts +37 -0
  82. package/dist-types/ts3.4/commands/CreatePermissionVersionCommand.d.ts +41 -0
  83. package/dist-types/ts3.4/commands/DeletePermissionCommand.d.ts +37 -0
  84. package/dist-types/ts3.4/commands/DeletePermissionVersionCommand.d.ts +41 -0
  85. package/dist-types/ts3.4/commands/ListPermissionAssociationsCommand.d.ts +41 -0
  86. package/dist-types/ts3.4/commands/ListReplacePermissionAssociationsWorkCommand.d.ts +41 -0
  87. package/dist-types/ts3.4/commands/PromotePermissionCreatedFromPolicyCommand.d.ts +41 -0
  88. package/dist-types/ts3.4/commands/ReplacePermissionAssociationsCommand.d.ts +41 -0
  89. package/dist-types/ts3.4/commands/SetDefaultPermissionVersionCommand.d.ts +41 -0
  90. package/dist-types/ts3.4/commands/index.d.ts +9 -0
  91. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  92. package/dist-types/ts3.4/models/models_0.d.ts +234 -19
  93. package/dist-types/ts3.4/pagination/ListPermissionAssociationsPaginator.d.ts +11 -0
  94. package/dist-types/ts3.4/pagination/ListReplacePermissionAssociationsWorkPaginator.d.ts +11 -0
  95. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  96. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +108 -0
  97. package/package.json +6 -6
@@ -42,16 +42,19 @@ export interface ListResourceTypesCommandOutput extends ListResourceTypesRespons
42
42
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
43
43
  *
44
44
  * @throws {@link InvalidNextTokenException} (client fault)
45
- * <p>The specified value for <code>NextToken</code> is not valid.</p>
45
+ * <p>The operation failed because the specified value for <code>NextToken</code> isn't
46
+ * valid. You must specify a value you received in the <code>NextToken</code> response of a
47
+ * previous call to this operation.</p>
46
48
  *
47
49
  * @throws {@link InvalidParameterException} (client fault)
48
- * <p>A parameter is not valid.</p>
50
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
49
51
  *
50
52
  * @throws {@link ServerInternalException} (server fault)
51
- * <p>The service could not respond to the request due to an internal problem.</p>
53
+ * <p>The operation failed because the service could not respond to the request due to an
54
+ * internal problem. Try again later.</p>
52
55
  *
53
56
  * @throws {@link ServiceUnavailableException} (server fault)
54
- * <p>The service is not available.</p>
57
+ * <p>The operation failed because the service isn't available. Try again later.</p>
55
58
  *
56
59
  *
57
60
  */
@@ -52,25 +52,29 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
52
52
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
53
53
  *
54
54
  * @throws {@link InvalidNextTokenException} (client fault)
55
- * <p>The specified value for <code>NextToken</code> is not valid.</p>
55
+ * <p>The operation failed because the specified value for <code>NextToken</code> isn't
56
+ * valid. You must specify a value you received in the <code>NextToken</code> response of a
57
+ * previous call to this operation.</p>
56
58
  *
57
59
  * @throws {@link InvalidParameterException} (client fault)
58
- * <p>A parameter is not valid.</p>
60
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
59
61
  *
60
62
  * @throws {@link InvalidResourceTypeException} (client fault)
61
- * <p>The specified resource type is not valid.</p>
63
+ * <p>The operation failed because the specified resource type isn't valid.</p>
62
64
  *
63
65
  * @throws {@link MalformedArnException} (client fault)
64
- * <p>The format of an Amazon Resource Name (ARN) is not valid.</p>
66
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
67
+ * valid.</p>
65
68
  *
66
69
  * @throws {@link ServerInternalException} (server fault)
67
- * <p>The service could not respond to the request due to an internal problem.</p>
70
+ * <p>The operation failed because the service could not respond to the request due to an
71
+ * internal problem. Try again later.</p>
68
72
  *
69
73
  * @throws {@link ServiceUnavailableException} (server fault)
70
- * <p>The service is not available.</p>
74
+ * <p>The operation failed because the service isn't available. Try again later.</p>
71
75
  *
72
76
  * @throws {@link UnknownResourceException} (client fault)
73
- * <p>A specified resource was not found.</p>
77
+ * <p>The operation failed because a specified resource couldn't be found.</p>
74
78
  *
75
79
  *
76
80
  */
@@ -0,0 +1,119 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { PromotePermissionCreatedFromPolicyRequest, PromotePermissionCreatedFromPolicyResponse } from "../models/models_0";
5
+ import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link PromotePermissionCreatedFromPolicyCommand}.
10
+ */
11
+ export interface PromotePermissionCreatedFromPolicyCommandInput extends PromotePermissionCreatedFromPolicyRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link PromotePermissionCreatedFromPolicyCommand}.
17
+ */
18
+ export interface PromotePermissionCreatedFromPolicyCommandOutput extends PromotePermissionCreatedFromPolicyResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>When you attach a resource-based policy to a resource, RAM automatically creates
23
+ * a resource share of <code>featureSet</code>=<code>CREATED_FROM_POLICY</code> with a managed permission that
24
+ * has the same IAM permissions as the original resource-based policy. However, this type
25
+ * of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by
26
+ * using RAM.</p>
27
+ * <p>This operation creates a separate, fully manageable customer managed permission that has the same IAM
28
+ * permissions as the original resource-based policy. You can associate this customer managed permission to any
29
+ * resource shares.</p>
30
+ * <p>Before you use <a>PromoteResourceShareCreatedFromPolicy</a>, you should
31
+ * first run this operation to ensure that you have an appropriate customer managed permission that can be
32
+ * associated with the promoted resource share.</p>
33
+ * <note>
34
+ * <ul>
35
+ * <li>
36
+ * <p>The original <code>CREATED_FROM_POLICY</code> policy isn't deleted, and
37
+ * resource shares using that original policy aren't automatically
38
+ * updated.</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>You can't modify a <code>CREATED_FROM_POLICY</code> resource share so you can't
42
+ * associate the new customer managed permission by using
43
+ * <code>ReplacePermsissionAssociations</code>. However, if you use <a>PromoteResourceShareCreatedFromPolicy</a>, that operation
44
+ * automatically associates the fully manageable customer managed permission to the newly promoted
45
+ * <code>STANDARD</code> resource share.</p>
46
+ * </li>
47
+ * <li>
48
+ * <p>After you promote a resource share, if the original <code>CREATED_FROM_POLICY</code>
49
+ * managed permission has no other associations to A resource share, then RAM automatically deletes
50
+ * it.</p>
51
+ * </li>
52
+ * </ul>
53
+ * </note>
54
+ * @example
55
+ * Use a bare-bones client and the command you need to make an API call.
56
+ * ```javascript
57
+ * import { RAMClient, PromotePermissionCreatedFromPolicyCommand } from "@aws-sdk/client-ram"; // ES Modules import
58
+ * // const { RAMClient, PromotePermissionCreatedFromPolicyCommand } = require("@aws-sdk/client-ram"); // CommonJS import
59
+ * const client = new RAMClient(config);
60
+ * const input = { // PromotePermissionCreatedFromPolicyRequest
61
+ * permissionArn: "STRING_VALUE", // required
62
+ * name: "STRING_VALUE", // required
63
+ * clientToken: "STRING_VALUE",
64
+ * };
65
+ * const command = new PromotePermissionCreatedFromPolicyCommand(input);
66
+ * const response = await client.send(command);
67
+ * ```
68
+ *
69
+ * @param PromotePermissionCreatedFromPolicyCommandInput - {@link PromotePermissionCreatedFromPolicyCommandInput}
70
+ * @returns {@link PromotePermissionCreatedFromPolicyCommandOutput}
71
+ * @see {@link PromotePermissionCreatedFromPolicyCommandInput} for command's `input` shape.
72
+ * @see {@link PromotePermissionCreatedFromPolicyCommandOutput} for command's `response` shape.
73
+ * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
74
+ *
75
+ * @throws {@link InvalidParameterException} (client fault)
76
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
77
+ *
78
+ * @throws {@link MalformedArnException} (client fault)
79
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
80
+ * valid.</p>
81
+ *
82
+ * @throws {@link MissingRequiredParameterException} (client fault)
83
+ * <p>The operation failed because a required input parameter is missing.</p>
84
+ *
85
+ * @throws {@link OperationNotPermittedException} (client fault)
86
+ * <p>The operation failed because the requested operation isn't permitted.</p>
87
+ *
88
+ * @throws {@link ServerInternalException} (server fault)
89
+ * <p>The operation failed because the service could not respond to the request due to an
90
+ * internal problem. Try again later.</p>
91
+ *
92
+ * @throws {@link ServiceUnavailableException} (server fault)
93
+ * <p>The operation failed because the service isn't available. Try again later.</p>
94
+ *
95
+ * @throws {@link UnknownResourceException} (client fault)
96
+ * <p>The operation failed because a specified resource couldn't be found.</p>
97
+ *
98
+ *
99
+ */
100
+ export declare class PromotePermissionCreatedFromPolicyCommand extends $Command<PromotePermissionCreatedFromPolicyCommandInput, PromotePermissionCreatedFromPolicyCommandOutput, RAMClientResolvedConfig> {
101
+ readonly input: PromotePermissionCreatedFromPolicyCommandInput;
102
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
103
+ /**
104
+ * @public
105
+ */
106
+ constructor(input: PromotePermissionCreatedFromPolicyCommandInput);
107
+ /**
108
+ * @internal
109
+ */
110
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PromotePermissionCreatedFromPolicyCommandInput, PromotePermissionCreatedFromPolicyCommandOutput>;
111
+ /**
112
+ * @internal
113
+ */
114
+ private serialize;
115
+ /**
116
+ * @internal
117
+ */
118
+ private deserialize;
119
+ }
@@ -19,12 +19,20 @@ export interface PromoteResourceShareCreatedFromPolicyCommandOutput extends Prom
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>When you attach a resource-based permission policy to a resource, it automatically
23
- * creates a resource share. However, resource shares created this way are visible only to the resource share owner, and
24
- * the resource share can't be modified in RAM.</p>
25
- * <p>You can use this operation to promote the resource share to a full RAM resource share. When you promote
26
- * a resource share, you can then manage the resource share in RAM and it becomes visible to all of the
27
- * principals you shared it with.</p>
22
+ * <p>When you attach a resource-based policy to a resource, RAM automatically creates
23
+ * a resource share of <code>featureSet</code>=<code>CREATED_FROM_POLICY</code> with a managed permission that
24
+ * has the same IAM permissions as the original resource-based policy. However, this type
25
+ * of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by
26
+ * using RAM.</p>
27
+ * <p>This operation promotes the resource share to a <code>STANDARD</code> resource share that is fully
28
+ * manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and
29
+ * it becomes visible to all of the principals you shared it with.</p>
30
+ * <important>
31
+ * <p>Before you perform this operation, you should first run <a>PromotePermissionCreatedFromPolicy</a>to ensure that you have an
32
+ * appropriate customer managed permission that can be associated with this resource share after its is promoted. If
33
+ * this operation can't find a managed permission that exactly matches the existing
34
+ * <code>CREATED_FROM_POLICY</code> permission, then this operation fails.</p>
35
+ * </important>
28
36
  * @example
29
37
  * Use a bare-bones client and the command you need to make an API call.
30
38
  * ```javascript
@@ -45,28 +53,40 @@ export interface PromoteResourceShareCreatedFromPolicyCommandOutput extends Prom
45
53
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
46
54
  *
47
55
  * @throws {@link InvalidParameterException} (client fault)
48
- * <p>A parameter is not valid.</p>
56
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
57
+ *
58
+ * @throws {@link InvalidStateTransitionException} (client fault)
59
+ * <p>The operation failed because the requested operation isn't valid for the resource
60
+ * share in its current state.</p>
49
61
  *
50
62
  * @throws {@link MalformedArnException} (client fault)
51
- * <p>The format of an Amazon Resource Name (ARN) is not valid.</p>
63
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
64
+ * valid.</p>
52
65
  *
53
66
  * @throws {@link MissingRequiredParameterException} (client fault)
54
- * <p>A required input parameter is missing.</p>
67
+ * <p>The operation failed because a required input parameter is missing.</p>
55
68
  *
56
69
  * @throws {@link OperationNotPermittedException} (client fault)
57
- * <p>The requested operation is not permitted.</p>
70
+ * <p>The operation failed because the requested operation isn't permitted.</p>
58
71
  *
59
72
  * @throws {@link ResourceShareLimitExceededException} (client fault)
60
- * <p>This request would exceed the limit for resource shares for your account.</p>
73
+ * <p>The operation failed because it would exceed the limit for resource shares for your account. To
74
+ * view the limits for your Amazon Web Services account, see the <a href="https://console.aws.amazon.com/servicequotas/home/services/ram/quotas">RAM page in the Service Quotas
75
+ * console</a>.</p>
61
76
  *
62
77
  * @throws {@link ServerInternalException} (server fault)
63
- * <p>The service could not respond to the request due to an internal problem.</p>
78
+ * <p>The operation failed because the service could not respond to the request due to an
79
+ * internal problem. Try again later.</p>
64
80
  *
65
81
  * @throws {@link ServiceUnavailableException} (server fault)
66
- * <p>The service is not available.</p>
82
+ * <p>The operation failed because the service isn't available. Try again later.</p>
67
83
  *
68
84
  * @throws {@link UnknownResourceException} (client fault)
69
- * <p>A specified resource was not found.</p>
85
+ * <p>The operation failed because a specified resource couldn't be found.</p>
86
+ *
87
+ * @throws {@link UnmatchedPolicyPermissionException} (client fault)
88
+ * <p>There isn't an existing managed permission defined in RAM that has the same IAM permissions as
89
+ * the resource-based policy attached to the resource. You should first run <a>PromotePermissionCreatedFromPolicy</a> to create that managed permission.</p>
70
90
  *
71
91
  *
72
92
  */
@@ -41,36 +41,40 @@ export interface RejectResourceShareInvitationCommandOutput extends RejectResour
41
41
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
42
42
  *
43
43
  * @throws {@link IdempotentParameterMismatchException} (client fault)
44
- * <p>The client token input parameter was matched one used with a previous call to the
45
- * operation, but at least one of the other input parameters is different from the previous
46
- * call.</p>
44
+ * <p>The operation failed because the client token input parameter matched one that was
45
+ * used with a previous call to the operation, but at least one of the other input
46
+ * parameters is different from the previous call.</p>
47
47
  *
48
48
  * @throws {@link InvalidClientTokenException} (client fault)
49
- * <p>The client token is not valid.</p>
49
+ * <p>The operation failed because the specified client token isn't valid.</p>
50
50
  *
51
51
  * @throws {@link MalformedArnException} (client fault)
52
- * <p>The format of an Amazon Resource Name (ARN) is not valid.</p>
52
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
53
+ * valid.</p>
53
54
  *
54
55
  * @throws {@link OperationNotPermittedException} (client fault)
55
- * <p>The requested operation is not permitted.</p>
56
+ * <p>The operation failed because the requested operation isn't permitted.</p>
56
57
  *
57
58
  * @throws {@link ResourceShareInvitationAlreadyAcceptedException} (client fault)
58
- * <p>The specified invitation was already accepted.</p>
59
+ * <p>The operation failed because the specified invitation was already accepted.</p>
59
60
  *
60
61
  * @throws {@link ResourceShareInvitationAlreadyRejectedException} (client fault)
61
- * <p>The specified invitation was already rejected.</p>
62
+ * <p>The operation failed because the specified invitation was already rejected.</p>
62
63
  *
63
64
  * @throws {@link ResourceShareInvitationArnNotFoundException} (client fault)
64
- * <p>The specified Amazon Resource Name (ARN) for an invitation was not found.</p>
65
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> for an invitation was not
66
+ * found.</p>
65
67
  *
66
68
  * @throws {@link ResourceShareInvitationExpiredException} (client fault)
67
- * <p>The specified invitation is expired.</p>
69
+ * <p>The operation failed because the specified invitation is past its expiration date and
70
+ * time.</p>
68
71
  *
69
72
  * @throws {@link ServerInternalException} (server fault)
70
- * <p>The service could not respond to the request due to an internal problem.</p>
73
+ * <p>The operation failed because the service could not respond to the request due to an
74
+ * internal problem. Try again later.</p>
71
75
  *
72
76
  * @throws {@link ServiceUnavailableException} (server fault)
73
- * <p>The service is not available.</p>
77
+ * <p>The operation failed because the service isn't available. Try again later.</p>
74
78
  *
75
79
  *
76
80
  */
@@ -0,0 +1,108 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ReplacePermissionAssociationsRequest, ReplacePermissionAssociationsResponse } from "../models/models_0";
5
+ import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link ReplacePermissionAssociationsCommand}.
10
+ */
11
+ export interface ReplacePermissionAssociationsCommandInput extends ReplacePermissionAssociationsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link ReplacePermissionAssociationsCommand}.
17
+ */
18
+ export interface ReplacePermissionAssociationsCommandOutput extends ReplacePermissionAssociationsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Updates all resource shares that use a managed permission to a different managed
23
+ * permission. This operation always applies the default version of the target managed
24
+ * permission. You can optionally specify that the update applies to only resource shares that
25
+ * currently use a specified version. This enables you to update to the latest version,
26
+ * without changing the which managed permission is used.</p>
27
+ * <p>You can use this operation to update all of your resource shares to use the current
28
+ * default version of the permission by specifying the same value for the
29
+ * <code>fromPermissionArn</code> and <code>toPermissionArn</code> parameters.</p>
30
+ * <p>You can use the optional <code>fromPermissionVersion</code> parameter to update only
31
+ * those resources that use a specified version of the managed permission to the new managed
32
+ * permission.</p>
33
+ * <important>
34
+ * <p>To successfully perform this operation, you must have permission to update the
35
+ * resource-based policy on all affected resource types.</p>
36
+ * </important>
37
+ * @example
38
+ * Use a bare-bones client and the command you need to make an API call.
39
+ * ```javascript
40
+ * import { RAMClient, ReplacePermissionAssociationsCommand } from "@aws-sdk/client-ram"; // ES Modules import
41
+ * // const { RAMClient, ReplacePermissionAssociationsCommand } = require("@aws-sdk/client-ram"); // CommonJS import
42
+ * const client = new RAMClient(config);
43
+ * const input = { // ReplacePermissionAssociationsRequest
44
+ * fromPermissionArn: "STRING_VALUE", // required
45
+ * fromPermissionVersion: Number("int"),
46
+ * toPermissionArn: "STRING_VALUE", // required
47
+ * clientToken: "STRING_VALUE",
48
+ * };
49
+ * const command = new ReplacePermissionAssociationsCommand(input);
50
+ * const response = await client.send(command);
51
+ * ```
52
+ *
53
+ * @param ReplacePermissionAssociationsCommandInput - {@link ReplacePermissionAssociationsCommandInput}
54
+ * @returns {@link ReplacePermissionAssociationsCommandOutput}
55
+ * @see {@link ReplacePermissionAssociationsCommandInput} for command's `input` shape.
56
+ * @see {@link ReplacePermissionAssociationsCommandOutput} for command's `response` shape.
57
+ * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
58
+ *
59
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
60
+ * <p>The operation failed because the client token input parameter matched one that was
61
+ * used with a previous call to the operation, but at least one of the other input
62
+ * parameters is different from the previous call.</p>
63
+ *
64
+ * @throws {@link InvalidClientTokenException} (client fault)
65
+ * <p>The operation failed because the specified client token isn't valid.</p>
66
+ *
67
+ * @throws {@link InvalidParameterException} (client fault)
68
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
69
+ *
70
+ * @throws {@link MalformedArnException} (client fault)
71
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
72
+ * valid.</p>
73
+ *
74
+ * @throws {@link OperationNotPermittedException} (client fault)
75
+ * <p>The operation failed because the requested operation isn't permitted.</p>
76
+ *
77
+ * @throws {@link ServerInternalException} (server fault)
78
+ * <p>The operation failed because the service could not respond to the request due to an
79
+ * internal problem. Try again later.</p>
80
+ *
81
+ * @throws {@link ServiceUnavailableException} (server fault)
82
+ * <p>The operation failed because the service isn't available. Try again later.</p>
83
+ *
84
+ * @throws {@link UnknownResourceException} (client fault)
85
+ * <p>The operation failed because a specified resource couldn't be found.</p>
86
+ *
87
+ *
88
+ */
89
+ export declare class ReplacePermissionAssociationsCommand extends $Command<ReplacePermissionAssociationsCommandInput, ReplacePermissionAssociationsCommandOutput, RAMClientResolvedConfig> {
90
+ readonly input: ReplacePermissionAssociationsCommandInput;
91
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
92
+ /**
93
+ * @public
94
+ */
95
+ constructor(input: ReplacePermissionAssociationsCommandInput);
96
+ /**
97
+ * @internal
98
+ */
99
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ReplacePermissionAssociationsCommandInput, ReplacePermissionAssociationsCommandOutput>;
100
+ /**
101
+ * @internal
102
+ */
103
+ private serialize;
104
+ /**
105
+ * @internal
106
+ */
107
+ private deserialize;
108
+ }
@@ -0,0 +1,92 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { SetDefaultPermissionVersionRequest, SetDefaultPermissionVersionResponse } from "../models/models_0";
5
+ import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link SetDefaultPermissionVersionCommand}.
10
+ */
11
+ export interface SetDefaultPermissionVersionCommandInput extends SetDefaultPermissionVersionRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link SetDefaultPermissionVersionCommand}.
17
+ */
18
+ export interface SetDefaultPermissionVersionCommandOutput extends SetDefaultPermissionVersionResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Designates the specified version number as the default version for the specified
23
+ * customer managed permission. New resource shares automatically use this new default permission. Existing
24
+ * resource shares continue to use their original permission version, but you can use <a>ReplacePermissionAssociations</a> to update them.</p>
25
+ * @example
26
+ * Use a bare-bones client and the command you need to make an API call.
27
+ * ```javascript
28
+ * import { RAMClient, SetDefaultPermissionVersionCommand } from "@aws-sdk/client-ram"; // ES Modules import
29
+ * // const { RAMClient, SetDefaultPermissionVersionCommand } = require("@aws-sdk/client-ram"); // CommonJS import
30
+ * const client = new RAMClient(config);
31
+ * const input = { // SetDefaultPermissionVersionRequest
32
+ * permissionArn: "STRING_VALUE", // required
33
+ * permissionVersion: Number("int"), // required
34
+ * clientToken: "STRING_VALUE",
35
+ * };
36
+ * const command = new SetDefaultPermissionVersionCommand(input);
37
+ * const response = await client.send(command);
38
+ * ```
39
+ *
40
+ * @param SetDefaultPermissionVersionCommandInput - {@link SetDefaultPermissionVersionCommandInput}
41
+ * @returns {@link SetDefaultPermissionVersionCommandOutput}
42
+ * @see {@link SetDefaultPermissionVersionCommandInput} for command's `input` shape.
43
+ * @see {@link SetDefaultPermissionVersionCommandOutput} for command's `response` shape.
44
+ * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
45
+ *
46
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
47
+ * <p>The operation failed because the client token input parameter matched one that was
48
+ * used with a previous call to the operation, but at least one of the other input
49
+ * parameters is different from the previous call.</p>
50
+ *
51
+ * @throws {@link InvalidClientTokenException} (client fault)
52
+ * <p>The operation failed because the specified client token isn't valid.</p>
53
+ *
54
+ * @throws {@link InvalidParameterException} (client fault)
55
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
56
+ *
57
+ * @throws {@link MalformedArnException} (client fault)
58
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
59
+ * valid.</p>
60
+ *
61
+ * @throws {@link ServerInternalException} (server fault)
62
+ * <p>The operation failed because the service could not respond to the request due to an
63
+ * internal problem. Try again later.</p>
64
+ *
65
+ * @throws {@link ServiceUnavailableException} (server fault)
66
+ * <p>The operation failed because the service isn't available. Try again later.</p>
67
+ *
68
+ * @throws {@link UnknownResourceException} (client fault)
69
+ * <p>The operation failed because a specified resource couldn't be found.</p>
70
+ *
71
+ *
72
+ */
73
+ export declare class SetDefaultPermissionVersionCommand extends $Command<SetDefaultPermissionVersionCommandInput, SetDefaultPermissionVersionCommandOutput, RAMClientResolvedConfig> {
74
+ readonly input: SetDefaultPermissionVersionCommandInput;
75
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
79
+ constructor(input: SetDefaultPermissionVersionCommandInput);
80
+ /**
81
+ * @internal
82
+ */
83
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetDefaultPermissionVersionCommandInput, SetDefaultPermissionVersionCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
87
+ private serialize;
88
+ /**
89
+ * @internal
90
+ */
91
+ private deserialize;
92
+ }
@@ -19,8 +19,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Adds the specified tag keys and values to the specified resource share. The tags are attached
23
- * only to the resource share, not to the resources that are in the resource share.</p>
22
+ * <p>Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the
23
+ * tags are attached to only the resource share, not to the resources that are in the resource share.</p>
24
+ * <p>The tags on a managed permission are the same for all versions of the managed permission.</p>
24
25
  * @example
25
26
  * Use a bare-bones client and the command you need to make an API call.
26
27
  * ```javascript
@@ -28,13 +29,14 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
28
29
  * // const { RAMClient, TagResourceCommand } = require("@aws-sdk/client-ram"); // CommonJS import
29
30
  * const client = new RAMClient(config);
30
31
  * const input = { // TagResourceRequest
31
- * resourceShareArn: "STRING_VALUE", // required
32
+ * resourceShareArn: "STRING_VALUE",
32
33
  * tags: [ // TagList // required
33
34
  * { // Tag
34
35
  * key: "STRING_VALUE",
35
36
  * value: "STRING_VALUE",
36
37
  * },
37
38
  * ],
39
+ * resourceArn: "STRING_VALUE",
38
40
  * };
39
41
  * const command = new TagResourceCommand(input);
40
42
  * const response = await client.send(command);
@@ -47,28 +49,32 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
47
49
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
48
50
  *
49
51
  * @throws {@link InvalidParameterException} (client fault)
50
- * <p>A parameter is not valid.</p>
52
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
51
53
  *
52
54
  * @throws {@link MalformedArnException} (client fault)
53
- * <p>The format of an Amazon Resource Name (ARN) is not valid.</p>
55
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
56
+ * valid.</p>
54
57
  *
55
58
  * @throws {@link ResourceArnNotFoundException} (client fault)
56
- * <p>The specified Amazon Resource Name (ARN) was not found.</p>
59
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> was not found.</p>
57
60
  *
58
61
  * @throws {@link ServerInternalException} (server fault)
59
- * <p>The service could not respond to the request due to an internal problem.</p>
62
+ * <p>The operation failed because the service could not respond to the request due to an
63
+ * internal problem. Try again later.</p>
60
64
  *
61
65
  * @throws {@link ServiceUnavailableException} (server fault)
62
- * <p>The service is not available.</p>
66
+ * <p>The operation failed because the service isn't available. Try again later.</p>
63
67
  *
64
68
  * @throws {@link TagLimitExceededException} (client fault)
65
- * <p>This request would exceed the limit for tags for your account.</p>
69
+ * <p>The operation failed because it would exceed the limit for tags for your
70
+ * Amazon Web Services account.</p>
66
71
  *
67
72
  * @throws {@link TagPolicyViolationException} (client fault)
68
- * <p>The specified tag key is a reserved word and can't be used.</p>
73
+ * <p>The operation failed because the specified tag key is a reserved word and can't be
74
+ * used.</p>
69
75
  *
70
76
  * @throws {@link UnknownResourceException} (client fault)
71
- * <p>A specified resource was not found.</p>
77
+ * <p>The operation failed because a specified resource couldn't be found.</p>
72
78
  *
73
79
  *
74
80
  */
@@ -19,7 +19,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Removes the specified tag key and value pairs from the specified resource share.</p>
22
+ * <p>Removes the specified tag key and value pairs from the specified resource share or managed permission.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
@@ -27,10 +27,11 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
27
27
  * // const { RAMClient, UntagResourceCommand } = require("@aws-sdk/client-ram"); // CommonJS import
28
28
  * const client = new RAMClient(config);
29
29
  * const input = { // UntagResourceRequest
30
- * resourceShareArn: "STRING_VALUE", // required
30
+ * resourceShareArn: "STRING_VALUE",
31
31
  * tagKeys: [ // TagKeyList // required
32
32
  * "STRING_VALUE",
33
33
  * ],
34
+ * resourceArn: "STRING_VALUE",
34
35
  * };
35
36
  * const command = new UntagResourceCommand(input);
36
37
  * const response = await client.send(command);
@@ -43,13 +44,21 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
43
44
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
44
45
  *
45
46
  * @throws {@link InvalidParameterException} (client fault)
46
- * <p>A parameter is not valid.</p>
47
+ * <p>The operation failed because a parameter you specified isn't valid.</p>
48
+ *
49
+ * @throws {@link MalformedArnException} (client fault)
50
+ * <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't
51
+ * valid.</p>
47
52
  *
48
53
  * @throws {@link ServerInternalException} (server fault)
49
- * <p>The service could not respond to the request due to an internal problem.</p>
54
+ * <p>The operation failed because the service could not respond to the request due to an
55
+ * internal problem. Try again later.</p>
50
56
  *
51
57
  * @throws {@link ServiceUnavailableException} (server fault)
52
- * <p>The service is not available.</p>
58
+ * <p>The operation failed because the service isn't available. Try again later.</p>
59
+ *
60
+ * @throws {@link UnknownResourceException} (client fault)
61
+ * <p>The operation failed because a specified resource couldn't be found.</p>
53
62
  *
54
63
  *
55
64
  */