@aws-sdk/client-ram 3.296.0 → 3.297.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 (42) hide show
  1. package/dist-types/RAM.d.ts +26 -0
  2. package/dist-types/RAMClient.d.ts +24 -4
  3. package/dist-types/commands/AcceptResourceShareInvitationCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociateResourceShareCommand.d.ts +16 -0
  5. package/dist-types/commands/AssociateResourceSharePermissionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateResourceShareCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteResourceShareCommand.d.ts +16 -0
  8. package/dist-types/commands/DisassociateResourceShareCommand.d.ts +16 -0
  9. package/dist-types/commands/DisassociateResourceSharePermissionCommand.d.ts +16 -0
  10. package/dist-types/commands/EnableSharingWithAwsOrganizationCommand.d.ts +16 -0
  11. package/dist-types/commands/GetPermissionCommand.d.ts +16 -0
  12. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +16 -0
  13. package/dist-types/commands/GetResourceShareAssociationsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetResourceShareInvitationsCommand.d.ts +16 -0
  15. package/dist-types/commands/GetResourceSharesCommand.d.ts +16 -0
  16. package/dist-types/commands/ListPendingInvitationResourcesCommand.d.ts +16 -0
  17. package/dist-types/commands/ListPermissionVersionsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListPermissionsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListPrincipalsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListResourceSharePermissionsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListResourceTypesCommand.d.ts +16 -0
  22. package/dist-types/commands/ListResourcesCommand.d.ts +16 -0
  23. package/dist-types/commands/PromoteResourceShareCreatedFromPolicyCommand.d.ts +16 -0
  24. package/dist-types/commands/RejectResourceShareInvitationCommand.d.ts +16 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateResourceShareCommand.d.ts +16 -0
  28. package/dist-types/models/RAMServiceException.d.ts +2 -0
  29. package/dist-types/models/models_0.d.ts +209 -0
  30. package/dist-types/pagination/GetResourcePoliciesPaginator.d.ts +3 -0
  31. package/dist-types/pagination/GetResourceShareAssociationsPaginator.d.ts +3 -0
  32. package/dist-types/pagination/GetResourceShareInvitationsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/GetResourceSharesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/Interfaces.d.ts +3 -0
  35. package/dist-types/pagination/ListPendingInvitationResourcesPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListPermissionVersionsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListPermissionsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListPrincipalsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListResourceSharePermissionsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListResourceTypesPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListResourcesPaginator.d.ts +3 -0
  42. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PromoteResourceShareCreatedFromPolicyRequest, PromoteResourceShareCreatedFromPolicyResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PromoteResourceShareCreatedFromPolicyCommand}.
8
10
  */
9
11
  export interface PromoteResourceShareCreatedFromPolicyCommandInput extends PromoteResourceShareCreatedFromPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PromoteResourceShareCreatedFromPolicyCommand}.
13
17
  */
14
18
  export interface PromoteResourceShareCreatedFromPolicyCommandOutput extends PromoteResourceShareCreatedFromPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>When you attach a resource-based permission policy to a resource, it automatically
18
23
  * creates a resource share. However, resource shares created this way are visible only to the resource share owner, and
19
24
  * the resource share can't be modified in RAM.</p>
@@ -30,6 +35,8 @@ export interface PromoteResourceShareCreatedFromPolicyCommandOutput extends Prom
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param PromoteResourceShareCreatedFromPolicyCommandInput - {@link PromoteResourceShareCreatedFromPolicyCommandInput}
39
+ * @returns {@link PromoteResourceShareCreatedFromPolicyCommandOutput}
33
40
  * @see {@link PromoteResourceShareCreatedFromPolicyCommandInput} for command's `input` shape.
34
41
  * @see {@link PromoteResourceShareCreatedFromPolicyCommandOutput} for command's `response` shape.
35
42
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -63,11 +70,20 @@ export interface PromoteResourceShareCreatedFromPolicyCommandOutput extends Prom
63
70
  export declare class PromoteResourceShareCreatedFromPolicyCommand extends $Command<PromoteResourceShareCreatedFromPolicyCommandInput, PromoteResourceShareCreatedFromPolicyCommandOutput, RAMClientResolvedConfig> {
64
71
  readonly input: PromoteResourceShareCreatedFromPolicyCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: PromoteResourceShareCreatedFromPolicyCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PromoteResourceShareCreatedFromPolicyCommandInput, PromoteResourceShareCreatedFromPolicyCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RejectResourceShareInvitationRequest, RejectResourceShareInvitationResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RejectResourceShareInvitationCommand}.
8
10
  */
9
11
  export interface RejectResourceShareInvitationCommandInput extends RejectResourceShareInvitationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RejectResourceShareInvitationCommand}.
13
17
  */
14
18
  export interface RejectResourceShareInvitationCommandOutput extends RejectResourceShareInvitationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Rejects an invitation to a resource share from another Amazon Web Services account.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RejectResourceShareInvitationCommandOutput extends RejectResour
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RejectResourceShareInvitationCommandInput - {@link RejectResourceShareInvitationCommandInput}
34
+ * @returns {@link RejectResourceShareInvitationCommandOutput}
28
35
  * @see {@link RejectResourceShareInvitationCommandInput} for command's `input` shape.
29
36
  * @see {@link RejectResourceShareInvitationCommandOutput} for command's `response` shape.
30
37
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -66,11 +73,20 @@ export interface RejectResourceShareInvitationCommandOutput extends RejectResour
66
73
  export declare class RejectResourceShareInvitationCommand extends $Command<RejectResourceShareInvitationCommandInput, RejectResourceShareInvitationCommandOutput, RAMClientResolvedConfig> {
67
74
  readonly input: RejectResourceShareInvitationCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: RejectResourceShareInvitationCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RejectResourceShareInvitationCommandInput, RejectResourceShareInvitationCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds the specified tag keys and values to the specified resource share. The tags are attached
18
23
  * only to the resource share, not to the resources that are in the resource share.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
35
+ * @returns {@link TagResourceCommandOutput}
29
36
  * @see {@link TagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -59,11 +66,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
59
66
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, RAMClientResolvedConfig> {
60
67
  readonly input: TagResourceCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: TagResourceCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified tag key and value pairs from the specified resource share.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -43,11 +50,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
43
50
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, RAMClientResolvedConfig> {
44
51
  readonly input: UntagResourceCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: UntagResourceCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateResourceShareRequest, UpdateResourceShareResponse } from "../models/models_0";
5
5
  import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateResourceShareCommand}.
8
10
  */
9
11
  export interface UpdateResourceShareCommandInput extends UpdateResourceShareRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateResourceShareCommand}.
13
17
  */
14
18
  export interface UpdateResourceShareCommandOutput extends UpdateResourceShareResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Modifies some of the properties of the specified resource share.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateResourceShareCommandOutput extends UpdateResourceShareRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateResourceShareCommandInput - {@link UpdateResourceShareCommandInput}
34
+ * @returns {@link UpdateResourceShareCommandOutput}
28
35
  * @see {@link UpdateResourceShareCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateResourceShareCommandOutput} for command's `response` shape.
30
37
  * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateResourceShareCommandOutput extends UpdateResourceShareRes
63
70
  export declare class UpdateResourceShareCommand extends $Command<UpdateResourceShareCommandInput, UpdateResourceShareCommandOutput, RAMClientResolvedConfig> {
64
71
  readonly input: UpdateResourceShareCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: UpdateResourceShareCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RAMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateResourceShareCommandInput, UpdateResourceShareCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from RAM service.
4
6
  */
5
7
  export declare class RAMServiceException extends __ServiceException {