DeleteKeyPair

Amazon Elastic Compute Cloud: 2009-07-15

previous page next page

DeleteKeyPair

Description

Deletes the specified key pair, by removing the public key from Amazon EC2. You must own the key pair.

Request Parameters

NameDescriptionRequired

DeleteKeyPairType

DeleteKeyPairType element.

Type:

DeleteKeyPairType

Ancestor: None

Children: keyName

keyName

Name of the key pair to delete.

Type: xsd:string

Default: None

Ancestor: DeleteKeyPairType

Children: None

Yes

Response Elements

Name Description

DeleteKeyPairResponseType

DeleteKeyPairResponseType element.

Type: DeleteKeyPairResponseType

Ancestor: None

Children: requestId, return

requestId

The ID of the request.

Type: xsd:string

Ancestor: DeleteKeyPairResponseType

Children: None

return

Returns "true" if deletion succeeded; otherwise "false".

Type: xsd:boolean

Ancestor: DeleteKeyPairResponseType

Children: None

Examples

Example Request

This example deletes the gsg-keypair key pair.

<DeleteKeyPair xmlns="http://ec2.amazonaws.com/doc/2009-07-15/">
  <keyName>gsg-keypair</keyName>
</DeleteKeyPair>

Example Response

<DeleteKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2009-07-15/">
  <return>true</return>
</DeleteKeyPairResponse>
previous page start next page