EC2 / Client / delete_instance_connect_endpoint

delete_instance_connect_endpoint

EC2.Client.delete_instance_connect_endpoint(**kwargs)

Deletes the specified EC2 Instance Connect Endpoint.

See also: AWS API Documentation

Request Syntax

response = client.delete_instance_connect_endpoint(
    DryRun=True|False,
    InstanceConnectEndpointId='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.

• InstanceConnectEndpointId (string) –

  [REQUIRED]

  The ID of the EC2 Instance Connect Endpoint to delete.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceConnectEndpoint': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –

  • InstanceConnectEndpoint (dict) –

    Information about 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.