You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeVpcEndpointServicePermissionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeVpcEndpointServicePermissionsRequest data as a hash:

{
  dry_run: false,
  service_id: "String", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


16834
16835
16836
16837
16838
16839
16840
16841
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16834

class DescribeVpcEndpointServicePermissionsRequest < Struct.new(
  :dry_run,
  :service_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • principal - The ARN of the principal.

  • principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).

Returns:



16834
16835
16836
16837
16838
16839
16840
16841
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16834

class DescribeVpcEndpointServicePermissionsRequest < Struct.new(
  :dry_run,
  :service_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

Returns:

  • (Integer)


16834
16835
16836
16837
16838
16839
16840
16841
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16834

class DescribeVpcEndpointServicePermissionsRequest < Struct.new(
  :dry_run,
  :service_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


16834
16835
16836
16837
16838
16839
16840
16841
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16834

class DescribeVpcEndpointServicePermissionsRequest < Struct.new(
  :dry_run,
  :service_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#service_idString

The ID of the service.

Returns:

  • (String)


16834
16835
16836
16837
16838
16839
16840
16841
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16834

class DescribeVpcEndpointServicePermissionsRequest < Struct.new(
  :dry_run,
  :service_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end