EC2 / Client / describe_verified_access_groups

describe_verified_access_groups

EC2.Client.describe_verified_access_groups(**kwargs)

Describes the specified Verified Access groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_verified_access_groups(
    VerifiedAccessGroupIds=[
        'string',
    ],
    VerifiedAccessInstanceId='string',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

• VerifiedAccessGroupIds (list) –

  The ID of the Verified Access groups.

  • (string) –

• VerifiedAccessInstanceId (string) – The ID of the Verified Access instance.

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• Filters (list) –

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

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'VerifiedAccessGroups': [
        {
            'VerifiedAccessGroupId': 'string',
            'VerifiedAccessInstanceId': 'string',
            'Description': 'string',
            'Owner': 'string',
            'VerifiedAccessGroupArn': 'string',
            'CreationTime': 'string',
            'LastUpdatedTime': 'string',
            'DeletionTime': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SseSpecification': {
                'CustomerManagedKeyEnabled': True|False,
                'KmsKeyArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • VerifiedAccessGroups (list) –

    The ID of the Verified Access group.

    • (dict) –

      Describes a Verified Access group.

      • VerifiedAccessGroupId (string) –

        The ID of the Verified Access group.

      • VerifiedAccessInstanceId (string) –

        The ID of the Amazon Web Services Verified Access instance.

      • Description (string) –

        A description for the Amazon Web Services Verified Access group.

      • Owner (string) –

        The Amazon Web Services account number that owns the group.

      • VerifiedAccessGroupArn (string) –

        The ARN of the Verified Access group.

      • CreationTime (string) –

        The creation time.

      • LastUpdatedTime (string) –

        The last updated time.

      • DeletionTime (string) –

        The deletion time.

      • Tags (list) –

        The tags.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • SseSpecification (dict) –

        Describes the options in use for server side encryption.

        • CustomerManagedKeyEnabled (boolean) –

          Describes the use of customer managed KMS keys for server side encryption.

          Valid values: True | False

        • KmsKeyArn (string) –

          Describes the ARN of the KMS key.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.