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
• Struct
• Aws::EC2::Types::DescribeVpcEndpointServicePermissionsRequest

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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  One or more filters.

• #max_results ⇒ Integer

  The maximum number of results to return for the request in a single page.

• #next_token ⇒ String

  The token to retrieve the next page of results.

• #service_id ⇒ String

  The ID of the service.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13441

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

#filters ⇒ Array<Types::Filter>

One or more filters.

• principal - The ARN of the principal.

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

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13441

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

#max_results ⇒ Integer

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13441

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

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13441

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

#service_id ⇒ String

The ID of the service.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13441

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