AWS API Changes

2015/09/03 - AWS Storage Gateway - 3 new3 updated api methods

AddTagsToResource (new)

Link ¶

This operation adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

Storage gateways of all types
Storage Volumes
Virtual Tapes

You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

Request Syntax

client.add_tags_to_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource you want to add tags to.

type Tags:

list

param Tags:

[REQUIRED]

The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.

(dict) --
- Key (string) -- [REQUIRED]
- Value (string) -- [REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'ResourceARN': 'string'
}

Response Structure

(dict) --

AddTagsToResourceOutput
- ResourceARN (string) --
  
  The Amazon Resource Name (ARN) of the resource you want to add tags to.

RemoveTagsFromResource (new)

Link ¶

This operation removes one or more tags from the specified resource.

Request Syntax

client.remove_tags_from_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

type ResourceARN:

string

param ResourceARN:

The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

type TagKeys:

list

param TagKeys:

The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'ResourceARN': 'string'
}

Response Structure

(dict) --

RemoveTagsFromResourceOutput
- ResourceARN (string) --
  
  The Amazon Resource Name (ARN) of the resource that the tags were removed from.

ListTagsForResource (new)

Link ¶

This operation lists the tags that have been added to the specified resource.

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string',
    Marker='string',
    Limit=123
)

type ResourceARN:

string

param ResourceARN:

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

type Marker:

string

param Marker:

An opaque string that indicates the position at which to begin returning the list of tags.

type Limit:

integer

param Limit:

Specifies that the list of tags returned be limited to the specified number of items.

rtype:

dict

returns:

Response Syntax

{
    'ResourceARN': 'string',
    'Marker': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --

ListTagsForResourceOutput
- ResourceARN (string) --
  
  he Amazon Resource Name (ARN) of the resource for which you want to list tags.
- Marker (string) --
  
  An opaque string that indicates the position at which to stop returning the list of tags.
- Tags (list) --
  
  An array that contains the tags for the specified resource.
  - (dict) --
    - Key (string) --
    - Value (string) --

DescribeGatewayInformation (updated)

Link ¶
Changes (response)

{'GatewayName': 'string'}

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

client.describe_gateway_information(
    GatewayARN='string'
)

type GatewayARN:

string

param GatewayARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

rtype:

dict

returns:

Response Syntax

{
    'GatewayARN': 'string',
    'GatewayId': 'string',
    'GatewayName': 'string',
    'GatewayTimezone': 'string',
    'GatewayState': 'string',
    'GatewayNetworkInterfaces': [
        {
            'Ipv4Address': 'string',
            'MacAddress': 'string',
            'Ipv6Address': 'string'
        },
    ],
    'GatewayType': 'string',
    'NextUpdateAvailabilityDate': 'string',
    'LastSoftwareUpdate': 'string'
}

Response Structure

(dict) --

A JSON object containing the following fields:
- GatewayARN (string) --
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
- GatewayId (string) --
  
  The gateway ID.
- GatewayName (string) --
  
  The gateway name.
- GatewayTimezone (string) --
  
  One of the values that indicates the time zone configured for the gateway.
- GatewayState (string) --
  
  One of the values that indicates the operating state of the gateway.
- GatewayNetworkInterfaces (list) --
  
  A NetworkInterface array that contains descriptions of the gateway network interfaces.
  - (dict) --
    
    Describes a gateway's network interface.
    - Ipv4Address (string) --
      
      The Internet Protocol version 4 (IPv4) address of the interface.
    - MacAddress (string) --
      
      The Media Access Control (MAC) address of the interface.
      
      Note
      
      This is currently unsupported and will not be returned in output.
    - Ipv6Address (string) --
      
      The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
- GatewayType (string) --
  
  The type of the gateway.
- NextUpdateAvailabilityDate (string) --
  
  The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
- LastSoftwareUpdate (string) --
  
  The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

ListGateways (updated)

Link ¶
Changes (response)

{'Gateways': {'GatewayName': 'string'}}

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.

Request Syntax

client.list_gateways(
    Marker='string',
    Limit=123
)

type Marker:

string

param Marker:

An opaque string that indicates the position at which to begin the returned list of gateways.

type Limit:

integer

param Limit:

Specifies that the list of gateways returned be limited to the specified number of items.

rtype:

dict

returns:

Response Syntax

{
    'Gateways': [
        {
            'GatewayARN': 'string',
            'GatewayType': 'string',
            'GatewayOperationalState': 'string',
            'GatewayName': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) --
- Gateways (list) --
  - (dict) --
    - GatewayARN (string) --
      
      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
    - GatewayType (string) --
    - GatewayOperationalState (string) --
    - GatewayName (string) --
- Marker (string) --

UpdateGatewayInformation (updated)

Link ¶
Changes (response)

{'GatewayName': 'string'}

This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

client.update_gateway_information(
    GatewayARN='string',
    GatewayName='string',
    GatewayTimezone='string'
)

type GatewayARN:

string

param GatewayARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

type GatewayName:

string

param GatewayName:

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

type GatewayTimezone:

string

param GatewayTimezone:

rtype:

dict

returns:

Response Syntax

{
    'GatewayARN': 'string',
    'GatewayName': 'string'
}

Response Structure

(dict) --

A JSON object containing the of the gateway that was updated.
- GatewayARN (string) --
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
- GatewayName (string) --