EC2 / Client / describe_verified_access_endpoints

describe_verified_access_endpoints#

EC2.Client.describe_verified_access_endpoints(**kwargs)#

Describes the specified Amazon Web Services Verified Access endpoints.

See also: AWS API Documentation

Request Syntax

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

  • VerifiedAccessEndpointIds (list) –

    The ID of the Verified Access endpoint.

    • (string) –

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

  • VerifiedAccessGroupId (string) – The ID of the Verified Access group.

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

      For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

      • 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

{
    'VerifiedAccessEndpoints': [
        {
            'VerifiedAccessInstanceId': 'string',
            'VerifiedAccessGroupId': 'string',
            'VerifiedAccessEndpointId': 'string',
            'ApplicationDomain': 'string',
            'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr',
            'AttachmentType': 'vpc',
            'DomainCertificateArn': 'string',
            'EndpointDomain': 'string',
            'DeviceValidationDomain': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'LoadBalancerOptions': {
                'Protocol': 'http'|'https'|'tcp',
                'Port': 123,
                'LoadBalancerArn': 'string',
                'SubnetIds': [
                    'string',
                ],
                'PortRanges': [
                    {
                        'FromPort': 123,
                        'ToPort': 123
                    },
                ]
            },
            'NetworkInterfaceOptions': {
                'NetworkInterfaceId': 'string',
                'Protocol': 'http'|'https'|'tcp',
                'Port': 123,
                'PortRanges': [
                    {
                        'FromPort': 123,
                        'ToPort': 123
                    },
                ]
            },
            'Status': {
                'Code': 'pending'|'active'|'updating'|'deleting'|'deleted',
                'Message': 'string'
            },
            'Description': 'string',
            'CreationTime': 'string',
            'LastUpdatedTime': 'string',
            'DeletionTime': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SseSpecification': {
                'CustomerManagedKeyEnabled': True|False,
                'KmsKeyArn': 'string'
            },
            'RdsOptions': {
                'Protocol': 'http'|'https'|'tcp',
                'Port': 123,
                'RdsDbInstanceArn': 'string',
                'RdsDbClusterArn': 'string',
                'RdsDbProxyArn': 'string',
                'RdsEndpoint': 'string',
                'SubnetIds': [
                    'string',
                ]
            },
            'CidrOptions': {
                'Cidr': 'string',
                'PortRanges': [
                    {
                        'FromPort': 123,
                        'ToPort': 123
                    },
                ],
                'Protocol': 'http'|'https'|'tcp',
                'SubnetIds': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • VerifiedAccessEndpoints (list) –

      Details about the Verified Access endpoints.

      • (dict) –

        An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy before you attached it to a group.

        • VerifiedAccessInstanceId (string) –

          The ID of the Amazon Web Services Verified Access instance.

        • VerifiedAccessGroupId (string) –

          The ID of the Amazon Web Services Verified Access group.

        • VerifiedAccessEndpointId (string) –

          The ID of the Amazon Web Services Verified Access endpoint.

        • ApplicationDomain (string) –

          The DNS name for users to reach your application.

        • EndpointType (string) –

          The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.

        • AttachmentType (string) –

          The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.

        • DomainCertificateArn (string) –

          The ARN of a public TLS/SSL certificate imported into or created with ACM.

        • EndpointDomain (string) –

          A DNS name that is generated for the endpoint.

        • DeviceValidationDomain (string) –

          Returned if endpoint has a device trust provider attached.

        • SecurityGroupIds (list) –

          The IDs of the security groups for the endpoint.

          • (string) –

        • LoadBalancerOptions (dict) –

          The load balancer details if creating the Amazon Web Services Verified Access endpoint as ``load-balancer``type.

          • Protocol (string) –

            The IP protocol.

          • Port (integer) –

            The IP port number.

          • LoadBalancerArn (string) –

            The ARN of the load balancer.

          • SubnetIds (list) –

            The IDs of the subnets.

            • (string) –

          • PortRanges (list) –

            The port ranges.

            • (dict) –

              Describes a port range.

              • FromPort (integer) –

                The start of the port range.

              • ToPort (integer) –

                The end of the port range.

        • NetworkInterfaceOptions (dict) –

          The options for network-interface type endpoint.

          • NetworkInterfaceId (string) –

            The ID of the network interface.

          • Protocol (string) –

            The IP protocol.

          • Port (integer) –

            The IP port number.

          • PortRanges (list) –

            The port ranges.

            • (dict) –

              Describes a port range.

              • FromPort (integer) –

                The start of the port range.

              • ToPort (integer) –

                The end of the port range.

        • Status (dict) –

          The endpoint status.

          • Code (string) –

            The status code of the Verified Access endpoint.

          • Message (string) –

            The status message of the Verified Access endpoint.

        • Description (string) –

          A description for the Amazon Web Services Verified Access endpoint.

        • 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) –

          The options in use for server side encryption.

          • CustomerManagedKeyEnabled (boolean) –

            Indicates whether customer managed KMS keys are in use for server side encryption.

            Valid values: True | False

          • KmsKeyArn (string) –

            The ARN of the KMS key.

        • RdsOptions (dict) –

          The options for an RDS endpoint.

          • Protocol (string) –

            The protocol.

          • Port (integer) –

            The port.

          • RdsDbInstanceArn (string) –

            The ARN of the RDS instance.

          • RdsDbClusterArn (string) –

            The ARN of the DB cluster.

          • RdsDbProxyArn (string) –

            The ARN of the RDS proxy.

          • RdsEndpoint (string) –

            The RDS endpoint.

          • SubnetIds (list) –

            The IDs of the subnets.

            • (string) –

        • CidrOptions (dict) –

          The options for a CIDR endpoint.

          • Cidr (string) –

            The CIDR.

          • PortRanges (list) –

            The port ranges.

            • (dict) –

              Describes a port range.

              • FromPort (integer) –

                The start of the port range.

              • ToPort (integer) –

                The end of the port range.

          • Protocol (string) –

            The protocol.

          • SubnetIds (list) –

            The IDs of the subnets.

            • (string) –

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