OpsWorks / Client / register_volume

register_volume#

OpsWorks.Client.register_volume(**kwargs)#

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.register_volume(
    Ec2VolumeId='string',
    StackId='string'
)
Parameters:

  • Ec2VolumeId (string) – The Amazon EBS volume ID.

  • StackId (string) –

    [REQUIRED]

    The stack ID.

Return type:

dict

Returns:

Response Syntax

{
    'VolumeId': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a RegisterVolume request.

    • VolumeId (string) –

      The volume ID.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException