Skip to Content

Modify Snapshot Attribute operation

The Modify Snapshot Attribute operation adds or removes permission settings for a specified snapshot.

The following figure shows a sample <items> XML element for the Modify Snapshot Attribute operation. 

Sample <items> XML element for the Modify Snapshot Attribute operation

<items>
   <item>
       <parameters>
           <snapshot-id></snapshot-id>
           <create-volume-permission>
             <!--You have a CHOICE of the next 2 items at this level-->
             <add>
                <!--Zero or more repetition-->
                <item>
                 <!--You have a CHOICE of the next 2 items at this level-->
                 <user-id></user-id>
                </item>
             </add>
           </create-volume-permission>
       </parameters>
   </item>
</items>

The following table shows adapter request elements for the Modify Snapshot Attribute operation. 

Adapter request elements for the Modify Snapshot Attribute 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: modify-snapshot-attribute

Yes

<snapshot-id>

Specifies the ID of the Amazon EBS snapshot that you want to modify

No

<create-volume-permission>

Specifies the create volume permission for the Amazon EBS snapshot that you want to modify

  • add: Adds permission
  • remove: Removes permission
  • user-id: Specifies the user ID of a user who can create volumes from the snapshot
  • group: Specifies the group that is allowed to create volumes from the snapshot (Currently, supports all.)

No

The following figure shows a sample adapter request for the Modify Snapshot Attribute operation. 

Sample adapter request for the Modify Snapshot Attribute 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>modify-snapshot-attribute</operation-name>
   <parameters>
       <snapshot-id>snap-62a6700a</snapshot-id>
       <create-volume-permission>
           <!--You have a CHOICE of the next 2 items at this level-->
           <add>
             <!--Zero or more repetition-->
             <item>
               <!--You have a CHOICE of the next 2 items at this level-->
               <user-id>622872856407</user-id>
             </item>
           </add>
       </create-volume-permission>
   </parameters>
</amazon-ec2-request>

The following figure shows a sample adapter response for the Modify Snapshot Attribute operation. 

Sample adapter response for the Modify Snapshot Attribute operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <ModifySnapshotAttributeResponse>
       <requestId>4f60de8a-af64-44dd-9517-c5b6e8ea6407</requestId>
       <return>true</return>
   </ModifySnapshotAttributeResponse>
</amazon-ec2-response>

 

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

BMC Atrium Orchestrator Content 20.14.01