Describe Security Groups operation


The Describe Security Groups operations retrieves information about the security groups that you own.

The following figure shows the sample <items> XML element for the Describe Security Groups operation. 

Sample <items> XML element for the Describe Security Groups operation

<items>
   <item>
       <parameters>
           <security-group-set>
               <!--Zero or more repetitions:-->
               <item>
                   <group-name></group-name>
               </item>
           </security-group-set>
       </parameters>
   </item>
</items>

The following table shows the adapter request elements for this request. 

Adapter request elements for the Describe Security Groups operation

Element

Definition

Required

<wsdl-location>

Specifies the target Web Service Description Language (WSDL) URL for Amazon EC2

Examples:

Conditional:

  • Required if not specified in the request
  • If specified in the configuration and request, the value in the request overrides the value in the configuration
<endpoint-address>

Specifies the web service endpoint for the adapter to use while performing operations on Amazon EC2 instances across different regions
Default value: US East region: http://us-east-1.ec2.amazonaws.com/

No

<signature-properties>

Specifies the mode for signing the adapter request

Conditional:

  • Required if not specified in the configuration
  • If <signature-properties mode = "key-files">, requires <private-key-file>
     and <certificate-file>
  • If <signature-properties mode = "key-data">, requires <private-key-data> and <certificate-data>
<operation-name>

Contains the name of the operation: describe-security-group

Yes

<security-group-set>

Specifies the set of security groups containing the name of the security groups to be described

Yes

The following figure shows a sample adapter request for the Describe Security Groups operation. 

Sample adapter request for the Describe Security Groups operation

<amazon-ec2-request>
   <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/</wsdl-location>
   <endpoint-address>http://us-east-1.ec2.amazonaws.com/</endpoint-address>
   <signature-properties mode = "key-files">
       <private-key-file>C:\Security\
pk-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</private-key-file>
       <certificate-file>C:\Security\
cert-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</certificate-file>
   </signature-properties>
   <operation-name>describe-security-groups</operation-name>
   <parameters>
       <security-group-set>
           <item>
               <group-name>test1</group-name>
           </item>
       </security-group-set>
   </parameters>
</amazon-ec2-request>

The following figure shows the response for the sample adapter response for the Describe Security Groups operation. 

Sample adapter response for the Describe Security Groups operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <DescribeSecurityGroupsResponse>
       <requestId>3d33464d-1baa-4a7d-b9b2-7179c31945ae</requestId>
       <securityGroupInfo>
           <item>
               <ownerId>622872851117</ownerId>
               <groupName>test1</groupName>
               <groupDescription>testdescription</groupDescription>
               <ipPermissions>
                   <item>
                       <ipProtocol>tcp</ipProtocol>
                       <fromPort>80</fromPort>
                       <toPort>80</toPort>
                       <groups>
                           <item>
                               <userId>622872851117</userId>
                               <groupName>sec1</groupName>
                           </item>
                       </groups>
                       <ipRanges/>
                   </item>
                   <item>
                       <ipProtocol>tcp</ipProtocol>
                       <fromPort>10</fromPort>
                       <toPort>100</toPort>
                       <groups/>
                       <ipRanges>
                           <item>
                               <cidrIp>205.10.10.0/8</cidrIp>
                           </item>
                           <item>
                               <cidrIp>205.192.0.0/16</cidrIp>
                           </item>
                       </ipRanges>
                   </item>
               </ipPermissions>
           </item>
       </securityGroupInfo>
   </DescribeSecurityGroupsResponse>
</amazon-ec2-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*