aws-sdk-ram 1.12.0 → 1.17.0

data/lib/aws-sdk-ram/resource.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::RAM
+
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-ram/types.rb

@@ -50,6 +50,64 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass AssociateResourceSharePermissionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_share_arn: "String", # required
+    #         permission_arn: "String", # required
+    #         replace: false,
+    #         client_token: "String",
+    #       }
+    #
+    # @!attribute [rw] resource_share_arn
+    #   The Amazon Resource Name (ARN) of the resource share.
+    #   @return [String]
+    #
+    # @!attribute [rw] permission_arn
+    #   The ARN of the AWS RAM permission to associate with the resource
+    #   share.
+    #   @return [String]
+    #
+    # @!attribute [rw] replace
+    #   Indicates whether the permission should replace the permissions that
+    #   are currently associated with the resource share. Use `true` to
+    #   replace the current permissions. Use `false` to add the permission
+    #   to the current permission.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermissionRequest AWS API Documentation
+    #
+    class AssociateResourceSharePermissionRequest < Struct.new(
+      :resource_share_arn,
+      :permission_arn,
+      :replace,
+      :client_token)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] return_value
+    #   Indicates whether the request succeeded.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermissionResponse AWS API Documentation
+    #
+    class AssociateResourceSharePermissionResponse < Struct.new(
+      :return_value,
+      :client_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass AssociateResourceShareRequest
     #   data as a hash:
     #
@@ -119,6 +177,7 @@ module Aws::RAM
     #         ],
     #         allow_external_principals: false,
     #         client_token: "String",
+    #         permission_arns: ["String"],
     #       }
     #
     # @!attribute [rw] name
@@ -150,6 +209,13 @@ module Aws::RAM
     #   idempotency of the request.
     #   @return [String]
     #
+    # @!attribute [rw] permission_arns
+    #   The ARNs of the permissions to associate with the resource share. If
+    #   you do not specify an ARN for the permission, AWS RAM automatically
+    #   attaches the default version of the permission for each resource
+    #   type.
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareRequest AWS API Documentation
     #
     class CreateResourceShareRequest < Struct.new(
@@ -158,7 +224,8 @@ module Aws::RAM
       :principals,
       :tags,
       :allow_external_principals,
-      :client_token)
+      :client_token,
+      :permission_arns)
       include Aws::Structure
     end
 
@@ -221,6 +288,54 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DisassociateResourceSharePermissionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_share_arn: "String", # required
+    #         permission_arn: "String", # required
+    #         client_token: "String",
+    #       }
+    #
+    # @!attribute [rw] resource_share_arn
+    #   The Amazon Resource Name (ARN) of the resource share.
+    #   @return [String]
+    #
+    # @!attribute [rw] permission_arn
+    #   The ARN of the permission to disassociate from the resource share.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermissionRequest AWS API Documentation
+    #
+    class DisassociateResourceSharePermissionRequest < Struct.new(
+      :resource_share_arn,
+      :permission_arn,
+      :client_token)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] return_value
+    #   Indicates whether the request succeeded.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermissionResponse AWS API Documentation
+    #
+    class DisassociateResourceSharePermissionResponse < Struct.new(
+      :return_value,
+      :client_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DisassociateResourceShareRequest
     #   data as a hash:
     #
@@ -236,7 +351,7 @@ module Aws::RAM
     #   @return [String]
     #
     # @!attribute [rw] resource_arns
-    #   The Amazon Resource Names (ARN) of the resources.
+    #   The Amazon Resource Names (ARNs) of the resources.
     #   @return [Array<String>]
     #
     # @!attribute [rw] principals
@@ -292,6 +407,41 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetPermissionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         permission_arn: "String", # required
+    #         permission_version: 1,
+    #       }
+    #
+    # @!attribute [rw] permission_arn
+    #   The ARN of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] permission_version
+    #   The identifier for the version of the permission.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermissionRequest AWS API Documentation
+    #
+    class GetPermissionRequest < Struct.new(
+      :permission_arn,
+      :permission_version)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] permission
+    #   Information about the permission.
+    #   @return [Types::ResourceSharePermissionDetail]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermissionResponse AWS API Documentation
+    #
+    class GetPermissionResponse < Struct.new(
+      :permission)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetResourcePoliciesRequest
     #   data as a hash:
     #
@@ -361,7 +511,10 @@ module Aws::RAM
     #       }
     #
     # @!attribute [rw] association_type
-    #   The association type.
+    #   The association type. Specify `PRINCIPAL` to list the principals
+    #   that are associated with the specified resource share. Specify
+    #   `RESOURCE` to list the resources that are associated with the
+    #   specified resource share.
     #   @return [String]
     #
     # @!attribute [rw] resource_share_arns
@@ -690,6 +843,57 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListPermissionsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_type: "String",
+    #         next_token: "String",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] resource_type
+    #   Specifies the resource type for which to list permissions. For
+    #   example, to list only permissions that apply to EC2 subnets, specify
+    #   `ec2:Subnet`.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next page of results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return with a single call. To
+    #   retrieve the remaining results, make another call with the returned
+    #   `nextToken` value.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionsRequest AWS API Documentation
+    #
+    class ListPermissionsRequest < Struct.new(
+      :resource_type,
+      :next_token,
+      :max_results)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] permissions
+    #   Information about the permissions.
+    #   @return [Array<Types::ResourceSharePermissionSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results. This value is
+    #   `null` when there are no more results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionsResponse AWS API Documentation
+    #
+    class ListPermissionsResponse < Struct.new(
+      :permissions,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListPrincipalsRequest
     #   data as a hash:
     #
@@ -718,8 +922,13 @@ module Aws::RAM
     # @!attribute [rw] resource_type
     #   The resource type.
     #
-    #   Valid values: `route53resolver:ResolverRule` \| `ec2:TransitGateway`
-    #   \| `ec2:Subnet` \| `license-manager:LicenseConfiguration`
+    #   Valid values: `codebuild:Project` \| `codebuild:ReportGroup` \|
+    #   `ec2:CapacityReservation` \| `ec2:DedicatedHost` \| `ec2:Subnet` \|
+    #   `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
+    #   `imagebuilder:Component` \| `imagebuilder:Image` \|
+    #   `imagebuilder:ImageRecipe` \| `license-manager:LicenseConfiguration`
+    #   I `resource-groups:Group` \| `rds:Cluster` \|
+    #   `route53resolver:ResolverRule`
     #   @return [String]
     #
     # @!attribute [rw] resource_share_arns
@@ -766,6 +975,98 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListResourceSharePermissionsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_share_arn: "String", # required
+    #         next_token: "String",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] resource_share_arn
+    #   The Amazon Resource Name (ARN) of the resource share.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next page of results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return with a single call. To
+    #   retrieve the remaining results, make another call with the returned
+    #   `nextToken` value.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissionsRequest AWS API Documentation
+    #
+    class ListResourceSharePermissionsRequest < Struct.new(
+      :resource_share_arn,
+      :next_token,
+      :max_results)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] permissions
+    #   The permissions associated with the resource share.
+    #   @return [Array<Types::ResourceSharePermissionSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results. This value is
+    #   `null` when there are no more results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissionsResponse AWS API Documentation
+    #
+    class ListResourceSharePermissionsResponse < Struct.new(
+      :permissions,
+      :next_token)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass ListResourceTypesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         next_token: "String",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next page of results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return with a single call. To
+    #   retrieve the remaining results, make another call with the returned
+    #   `nextToken` value.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypesRequest AWS API Documentation
+    #
+    class ListResourceTypesRequest < Struct.new(
+      :next_token,
+      :max_results)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] resource_types
+    #   The shareable resource types supported by AWS RAM.
+    #   @return [Array<Types::ServiceNameAndResourceType>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results. This value is
+    #   `null` when there are no more results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypesResponse AWS API Documentation
+    #
+    class ListResourceTypesResponse < Struct.new(
+      :resource_types,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListResourcesRequest
     #   data as a hash:
     #
@@ -790,8 +1091,13 @@ module Aws::RAM
     # @!attribute [rw] resource_type
     #   The resource type.
     #
-    #   Valid values: `route53resolver:ResolverRule` \| `ec2:TransitGateway`
-    #   \| `ec2:Subnet` \| `license-manager:LicenseConfiguration`
+    #   Valid values: `codebuild:Project` \| `codebuild:ReportGroup` \|
+    #   `ec2:CapacityReservation` \| `ec2:DedicatedHost` \| `ec2:Subnet` \|
+    #   `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
+    #   `imagebuilder:Component` \| `imagebuilder:Image` \|
+    #   `imagebuilder:ImageRecipe` \| `license-manager:LicenseConfiguration`
+    #   I `resource-groups:Group` \| `rds:Cluster` \|
+    #   `route53resolver:ResolverRule`
     #   @return [String]
     #
     # @!attribute [rw] resource_arns
@@ -912,6 +1218,35 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass PromoteResourceShareCreatedFromPolicyRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_share_arn: "String", # required
+    #       }
+    #
+    # @!attribute [rw] resource_share_arn
+    #   The ARN of the resource share to promote.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicyRequest AWS API Documentation
+    #
+    class PromoteResourceShareCreatedFromPolicyRequest < Struct.new(
+      :resource_share_arn)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] return_value
+    #   Indicates whether the request succeeded.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicyResponse AWS API Documentation
+    #
+    class PromoteResourceShareCreatedFromPolicyResponse < Struct.new(
+      :return_value)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass RejectResourceShareInvitationRequest
     #   data as a hash:
     #
@@ -968,6 +1303,11 @@ module Aws::RAM
     #   The Amazon Resource Name (ARN) of the resource share.
     #   @return [String]
     #
+    # @!attribute [rw] resource_group_arn
+    #   The ARN of the resource group. This value is returned only if the
+    #   resource is a resource group.
+    #   @return [String]
+    #
     # @!attribute [rw] status
     #   The status of the resource.
     #   @return [String]
@@ -990,6 +1330,7 @@ module Aws::RAM
       :arn,
       :type,
       :resource_share_arn,
+      :resource_group_arn,
       :status,
       :status_message,
       :creation_time,
@@ -1048,6 +1389,25 @@ module Aws::RAM
     #   The time when the resource share was last updated.
     #   @return [Time]
     #
+    # @!attribute [rw] feature_set
+    #   Indicates how the resource share was created. Possible values
+    #   include:
+    #
+    #   * `CREATED_FROM_POLICY` - Indicates that the resource share was
+    #     created from an AWS Identity and Access Management (AWS IAM)
+    #     policy attached to a resource. These resource shares are visible
+    #     only to the AWS account that created it. They cannot be modified
+    #     in AWS RAM.
+    #
+    #   * `PROMOTING_TO_STANDARD` - The resource share is in the process of
+    #     being promoted. For more information, see
+    #     PromoteResourceShareCreatedFromPolicy.
+    #
+    #   * `STANDARD` - Indicates that the resource share was created in AWS
+    #     RAM using the console or APIs. These resource shares are visible
+    #     to all principals. They can be modified in AWS RAM.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShare AWS API Documentation
     #
     class ResourceShare < Struct.new(
@@ -1059,7 +1419,8 @@ module Aws::RAM
       :status_message,
       :tags,
       :creation_time,
-      :last_updated_time)
+      :last_updated_time,
+      :feature_set)
       include Aws::Structure
     end
 
@@ -1151,7 +1512,7 @@ module Aws::RAM
     #
     # @!attribute [rw] resource_share_associations
     #   To view the resources associated with a pending resource share
-    #   invitation, use [ListPendingInvitationResources][1].
+    #   invitation, use [ ListPendingInvitationResources][1].
     #
     #
     #
@@ -1232,6 +1593,108 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # Information about an AWS RAM permission.
+    #
+    # @!attribute [rw] arn
+    #   The ARN of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The identifier for the version of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] default_version
+    #   The identifier for the version of the permission that is set as the
+    #   default version.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] name
+    #   The name of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type to which the permission applies.
+    #   @return [String]
+    #
+    # @!attribute [rw] permission
+    #   The permission's effect and actions in JSON format. The `effect`
+    #   indicates whether the actions are allowed or denied. The `actions`
+    #   list the API actions to which the principal is granted or denied
+    #   access.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   The date and time when the permission was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_time
+    #   The date and time when the permission was last updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceSharePermissionDetail AWS API Documentation
+    #
+    class ResourceSharePermissionDetail < Struct.new(
+      :arn,
+      :version,
+      :default_version,
+      :name,
+      :resource_type,
+      :permission,
+      :creation_time,
+      :last_updated_time)
+      include Aws::Structure
+    end
+
+    # Information about a permission that is associated with a resource
+    # share.
+    #
+    # @!attribute [rw] arn
+    #   The ARN of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The identifier for the version of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] default_version
+    #   The identifier for the version of the permission that is set as the
+    #   default version.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] name
+    #   The name of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The type of resource to which the permission applies.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The current status of the permission.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   The date and time when the permission was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_time
+    #   The date and time when the permission was last updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceSharePermissionSummary AWS API Documentation
+    #
+    class ResourceSharePermissionSummary < Struct.new(
+      :arn,
+      :version,
+      :default_version,
+      :name,
+      :resource_type,
+      :status,
+      :creation_time,
+      :last_updated_time)
+      include Aws::Structure
+    end
+
     # The service could not respond to the request due to an internal
     # problem.
     #
@@ -1245,6 +1708,25 @@ module Aws::RAM
       include Aws::Structure
     end
 
+    # Information about the shareable resource types and the AWS services to
+    # which they belong.
+    #
+    # @!attribute [rw] resource_type
+    #   The shareable resource types.
+    #   @return [String]
+    #
+    # @!attribute [rw] service_name
+    #   The name of the AWS services to which the resources belong.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ServiceNameAndResourceType AWS API Documentation
+    #
+    class ServiceNameAndResourceType < Struct.new(
+      :resource_type,
+      :service_name)
+      include Aws::Structure
+    end
+
     # The service is not available.
     #
     # @!attribute [rw] message