describe_vpc_endpoint_service_permissions¶
Operation¶
describe_vpc_endpoint_service_permissions
¶
describe_vpc_endpoint_service_permissions(request: DescribeVpcEndpointServicePermissionsInput | DescribeVpcEndpointServicePermissionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointServicePermissionsInputDict]) -> DescribeVpcEndpointServicePermissionsOutput
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. Principal ARNs with path components aren't supported.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpcEndpointServicePermissionsInput | DescribeVpcEndpointServicePermissionsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeVpcEndpointServicePermissionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpcEndpointServicePermissionsOutput
|
An instance of |
describe_vpc_endpoint_service_permissions
async
¶
describe_vpc_endpoint_service_permissions(request: DescribeVpcEndpointServicePermissionsInput | DescribeVpcEndpointServicePermissionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointServicePermissionsInputDict]) -> DescribeVpcEndpointServicePermissionsOutput
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. Principal ARNs with path components aren't supported.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpcEndpointServicePermissionsInput | DescribeVpcEndpointServicePermissionsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeVpcEndpointServicePermissionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpcEndpointServicePermissionsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeVpcEndpointServicePermissionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpcEndpointServicePermissionsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
-
principal- The ARN of the principal. -
principal-type- The principal type (All|Service|OrganizationUnit|Account|User|Role).
max_results
instance-attribute
¶
max_results: int | None
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 1,000; if MaxResults is given a value larger than
1,000, only 1,000 results are returned.
DescribeVpcEndpointServicePermissionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcEndpointServicePermissionsInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
filters
class-attribute
instance-attribute
¶
The filters.
-
principal- The ARN of the principal. -
principal-type- The principal type (All|Service|OrganizationUnit|Account|User|Role).
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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 1,000; if MaxResults is given a value larger than
1,000, only 1,000 results are returned.
Output¶
DescribeVpcEndpointServicePermissionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcEndpointServicePermissionsOutput structure.
Attributes¶
allowed_principals
class-attribute
instance-attribute
¶
allowed_principals: list[AllowedPrincipal] | None = ...
Information about the allowed principals.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.