AWS API Changes

2019/11/20 - AWS Storage Gateway - 2 new 3 updated api methods

Changes The new DescribeAvailabilityMonitorTest API provides the results of the most recent High Availability monitoring test. The new StartAvailabilityMonitorTest API verifies the storage gateway is configured for High Availability monitoring. The new ActiveDirectoryStatus response element has been added to the DescribeSMBSettings and JoinDomain APIs to indicate the status of the gateway after the most recent JoinDomain operation. The new TimeoutInSeconds parameter of the JoinDomain API allows for the configuration of the timeout in which the JoinDomain operation must complete.

StartAvailabilityMonitorTest (new)

Link ¶

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

Note

Starting this test will cause your gateway to go offline for a brief period.

See also: AWS API Documentation

Request Syntax

client.start_availability_monitor_test(
    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 AWS Region.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

(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 AWS Region.

DescribeAvailabilityMonitorTest (new)

Link ¶

Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

See also: AWS API Documentation

Request Syntax

client.describe_availability_monitor_test(
    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 AWS Region.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string',
    'Status': 'COMPLETE'|'FAILED'|'PENDING',
    'StartTime': datetime(2015, 1, 1)
}

Response Structure

(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 AWS Region.
- Status (string) --
  
  The status of the High Availability monitoring test. If a test hasn't been performed, the value of this field is null.
- StartTime (datetime) --
  
  The time the High Availability monitoring test was started. If a test hasn't been performed, the value of this field is null.

DescribeGatewayInformation (updated)

Link ¶
Changes (response)

{'HostEnvironment': 'VMWARE | HYPER-V | EC2 | OTHER'}

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.

See also: AWS API Documentation

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 AWS 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',
    'Ec2InstanceId': 'string',
    'Ec2InstanceRegion': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'VPCEndpoint': 'string',
    'CloudWatchLogGroupARN': 'string',
    'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'OTHER'
}

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 AWS Region.
- GatewayId (string) --
  
  The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
- GatewayName (string) --
  
  The name you configured for your gateway.
- GatewayTimezone (string) --
  
  A value that indicates the time zone configured for the gateway.
- GatewayState (string) --
  
  A value 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.
- Ec2InstanceId (string) --
  
  The ID of the Amazon EC2 instance that was used to launch the gateway.
- Ec2InstanceRegion (string) --
  
  The AWS Region where the Amazon EC2 instance is located.
- Tags (list) --
  
  A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
  - (dict) --
    
    A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /
    - Key (string) --
      
      Tag key (String). The key can't start with aws:.
    - Value (string) --
      
      Value of the tag key.
- VPCEndpoint (string) --
  
  The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
- CloudWatchLogGroupARN (string) --
  
  The Amazon Resource Name (ARN) of the Amazon CloudWatch Log Group that is used to monitor events in the gateway.
- HostEnvironment (string) --
  
  The type of hypervisor environment used by the host.

DescribeSMBSettings (updated)

Link ¶
Changes (response)

{'ActiveDirectoryStatus': 'ACCESS_DENIED | DETACHED | JOINED | JOINING | '
                          'NETWORK_ERROR | TIMEOUT | UNKNOWN_ERROR'}

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

See also: AWS API Documentation

Request Syntax

client.describe_smb_settings(
    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 AWS Region.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string',
    'DomainName': 'string',
    'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR',
    'SMBGuestPasswordSet': True|False,
    'SMBSecurityStrategy': 'ClientSpecified'|'MandatorySigning'|'MandatoryEncryption'
}

Response Structure

(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 AWS Region.
- DomainName (string) --
  
  The name of the domain that the gateway is joined to.
- ActiveDirectoryStatus (string) --
  
  Indicates the status of a gateway that is a member of the Active Directory domain.
  - ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
  - DETACHED: Indicates that gateway is not joined to a domain.
  - JOINED: Indicates that the gateway has successfully joined a domain.
  - JOINING: Indicates that a JoinDomain operation is in progress.
  - NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
  - TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
  - UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.
- SMBGuestPasswordSet (boolean) --
  
  This value is true if a password for the guest user “smbguest” is set, and otherwise false.
- SMBSecurityStrategy (string) --
  
  The type of security strategy that was specified for file gateway.
  
  ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.
  
  MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
  
  MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

JoinDomain (updated)

Link ¶
Changes (request, response)
Request

{'TimeoutInSeconds': 'integer'}

Response

{'ActiveDirectoryStatus': 'ACCESS_DENIED | DETACHED | JOINED | JOINING | '
                          'NETWORK_ERROR | TIMEOUT | UNKNOWN_ERROR'}

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

See also: AWS API Documentation

Request Syntax

client.join_domain(
    GatewayARN='string',
    DomainName='string',
    OrganizationalUnit='string',
    DomainControllers=[
        'string',
    ],
    TimeoutInSeconds=123,
    UserName='string',
    Password='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 AWS Region.

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain that you want the gateway to join.

type OrganizationalUnit

string

param OrganizationalUnit

The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

type DomainControllers

list

param DomainControllers

List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389 .

(string) --

type TimeoutInSeconds

integer

param TimeoutInSeconds

Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

type UserName

string

param UserName

[REQUIRED]

Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.

type Password

string

param Password

[REQUIRED]

Sets the password of the user who has permission to add the gateway to the Active Directory domain.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string',
    'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR'
}

Response Structure

(dict) --

JoinDomainOutput
- GatewayARN (string) --
  
  The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
- ActiveDirectoryStatus (string) --
  
  Indicates the status of the gateway as a member of the Active Directory domain.
  - ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
  - DETACHED: Indicates that gateway is not joined to a domain.
  - JOINED: Indicates that the gateway has successfully joined a domain.
  - JOINING: Indicates that a JoinDomain operation is in progress.
  - NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
  - TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
  - UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.