Skip to content

EC2  >  Operations  >  describe_verified_access_groups

describe_verified_access_groups

Operation

describe_verified_access_groups async

describe_verified_access_groups(request: DescribeVerifiedAccessGroupsInput | DescribeVerifiedAccessGroupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVerifiedAccessGroupsOutput
describe_verified_access_groups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVerifiedAccessGroupsInputDict]) -> DescribeVerifiedAccessGroupsOutput

Describes the specified Verified Access groups.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DescribeVerifiedAccessGroupsOutput

An instance of DescribeVerifiedAccessGroupsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeVerifiedAccessGroupsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVerifiedAccessGroupsInput 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
filters: list[Filter] | None = ...

One or more filters. Filter names and values are case-sensitive.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

verified_access_group_ids class-attribute instance-attribute
verified_access_group_ids: list[str] | None = ...

The ID of the Verified Access groups.

verified_access_instance_id class-attribute instance-attribute
verified_access_instance_id: str | None = ...

The ID of the Verified Access instance.

Dictionaries

DescribeVerifiedAccessGroupsInputDict

Bases: TypedDict

Dictionary form of DescribeVerifiedAccessGroupsInput.

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

One or more filters. Filter names and values are case-sensitive.

max_results instance-attribute
max_results: int | None

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

verified_access_group_ids instance-attribute
verified_access_group_ids: Sequence[str] | None

The ID of the Verified Access groups.

verified_access_instance_id instance-attribute
verified_access_instance_id: str | None

The ID of the Verified Access instance.

Output

DescribeVerifiedAccessGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVerifiedAccessGroupsOutput structure.

Attributes

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
response_metadata: ResponseMetadata = ...

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.

verified_access_groups class-attribute instance-attribute
verified_access_groups: list[VerifiedAccessGroup] | None = ...

Details about the Verified Access groups.