EC2 / Client / describe_instance_connect_endpoints

describe_instance_connect_endpoints

EC2.Client.describe_instance_connect_endpoints(**kwargs)

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

• MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• Filters (list) –

  One or more filters.

  • instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint.

  • state - The state of the EC2 Instance Connect Endpoint ( create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).

  • subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • tag-value - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.

  • vpc-id - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

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

• InstanceConnectEndpointIds (list) –

  One or more EC2 Instance Connect Endpoint IDs.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'InstanceConnectEndpoints': [
        {
            'OwnerId': 'string',
            'InstanceConnectEndpointId': 'string',
            'InstanceConnectEndpointArn': 'string',
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
            'StateMessage': 'string',
            'DnsName': 'string',
            'FipsDnsName': 'string',
            'NetworkInterfaceIds': [
                'string',
            ],
            'VpcId': 'string',
            'AvailabilityZone': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'SubnetId': 'string',
            'PreserveClientIp': True|False,
            'SecurityGroupIds': [
                'string',
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • InstanceConnectEndpoints (list) –

    Information about the EC2 Instance Connect Endpoints.

    • (dict) –

      The EC2 Instance Connect Endpoint.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

      • InstanceConnectEndpointId (string) –

        The ID of the EC2 Instance Connect Endpoint.

      • InstanceConnectEndpointArn (string) –

        The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

      • State (string) –

        The current state of the EC2 Instance Connect Endpoint.

      • StateMessage (string) –

        The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.

      • DnsName (string) –

        The DNS name of the EC2 Instance Connect Endpoint.

      • FipsDnsName (string) –

      • NetworkInterfaceIds (list) –

        The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

        • (string) –

      • VpcId (string) –

        The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

      • AvailabilityZone (string) –

        The Availability Zone of the EC2 Instance Connect Endpoint.

      • CreatedAt (datetime) –

        The date and time that the EC2 Instance Connect Endpoint was created.

      • SubnetId (string) –

        The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

      • PreserveClientIp (boolean) –

        Indicates whether your client’s IP address is preserved as the source. The value is true or false.

        • If true, your client’s IP address is used when you connect to a resource.

        • If false, the elastic network interface IP address is used when you connect to a resource.

        Default: true

      • SecurityGroupIds (list) –

        The security groups associated with the endpoint. If you didn’t specify a security group, the default security group for your VPC is associated with the endpoint.

        • (string) –

      • Tags (list) –

        The tags assigned to the EC2 Instance Connect Endpoint.

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

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.