nas ¶

Table of Contents

nas

Client ¶

class nas.Client¶

A low-level client representing NIFCLOUD NAS

client = session.create_client('nas')

These are the available methods:

authorize_nas_security_group_ingress()
can_paginate()
clear_nas_session()
create_nas_instance()
create_nas_security_group()
delete_nas_instance()
delete_nas_security_group()
describe_nas_instances()
describe_nas_security_groups()
generate_presigned_url()
get_metric_statistics()
get_paginator()
get_waiter()
modify_nas_instance()
modify_nas_security_group()
revoke_nas_security_group_ingress()
upgrade_nas_instance()

authorize_nas_security_group_ingress(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.authorize_nas_security_group_ingress(
    CIDRIP='string',
    NASSecurityGroupName='string',
    SecurityGroupName='string'
)

Parameters:

CIDRIP (string) –
NASSecurityGroupName (string) – [REQUIRED]
SecurityGroupName (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NASSecurityGroup': {
        'AvailabilityZone': 'string',
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NASSecurityGroupDescription': 'string',
        'NASSecurityGroupName': 'string',
        'OwnerId': 'string',
        'SecurityGroups': [
            {
                'SecurityGroupName': 'string',
                'SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASSecurityGroup (dict) –
  - AvailabilityZone (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NASSecurityGroupDescription (string) –
  - NASSecurityGroupName (string) –
  - OwnerId (string) –
  - SecurityGroups (list) –
    - (dict) –
      - SecurityGroupName (string) –
      - SecurityGroupOwnerId (string) –
      - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Returns:	`True` if the operation can be paginated, `False` otherwise.

clear_nas_session(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.clear_nas_session(
    NASInstanceIdentifier='string',
    SessionClearType='0'|'1'
)

Parameters:

NASInstanceIdentifier (string) – [REQUIRED]
SessionClearType (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NASInstance': {
        'AllocatedStorage': 123,
        'AuthenticationType': 123,
        'AvailabilityZone': 'string',
        'DirectoryServiceDomainName': 'string',
        'DomainControllers': [
            {
                'Hostname': 'string',
                'IPAddress': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'PrivateAddress': 'string'
        },
        'MasterUsername': 'string',
        'NASInstanceClass': 'string',
        'NASInstanceDescription': 'string',
        'NASInstanceErrorInfo': {
            'NASInstanceErrorCode': 'string',
            'NASInstanceErrorMessage': 'string'
        },
        'NASInstanceIdentifier': 'string',
        'NASInstanceStatus': 'string',
        'NASInstanceType': 123,
        'NASSecurityGroups': [
            {
                'NASSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'NetworkId': 'string',
        'NoRootSquash': True|False,
        'Protocol': 'string',
        'StorageType': 123,
        'UpgradeRequired': True|False
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASInstance (dict) –
  - AllocatedStorage (integer) –
  - AuthenticationType (integer) –
  - AvailabilityZone (string) –
  - DirectoryServiceDomainName (string) –
  - DomainControllers (list) –
    - (dict) –
      - Hostname (string) –
      - IPAddress (string) –
  - Endpoint (dict) –
    - Address (string) –
    - PrivateAddress (string) –
  - MasterUsername (string) –
  - NASInstanceClass (string) –
  - NASInstanceDescription (string) –
  - NASInstanceErrorInfo (dict) –
    - NASInstanceErrorCode (string) –
    - NASInstanceErrorMessage (string) –
  - NASInstanceIdentifier (string) –
  - NASInstanceStatus (string) –
  - NASInstanceType (integer) –
  - NASSecurityGroups (list) –
    - (dict) –
      - NASSecurityGroupName (string) –
      - Status (string) –
  - NetworkId (string) –
  - NoRootSquash (boolean) –
  - Protocol (string) –
  - StorageType (integer) –
  - UpgradeRequired (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_nas_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_nas_instance(
    AllocatedStorage=123,
    AvailabilityZone='string',
    MasterPrivateAddress='string',
    MasterUserPassword='string',
    MasterUsername='string',
    NASInstanceDescription='string',
    NASInstanceIdentifier='string',
    NASInstanceType=123,
    NASSecurityGroups=[
        'string',
    ],
    NetworkId='string',
    Protocol='nfs'|'cifs'
)

Parameters:

AllocatedStorage (integer) – [REQUIRED]
AvailabilityZone (string) –
MasterPrivateAddress (string) –
MasterUserPassword (string) –
MasterUsername (string) –
NASInstanceDescription (string) –
NASInstanceIdentifier (string) – [REQUIRED]
NASInstanceType (integer) –
NASSecurityGroups (list) –
- (string) –
NetworkId (string) –
Protocol (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NASInstance': {
        'AllocatedStorage': 123,
        'AuthenticationType': 123,
        'AvailabilityZone': 'string',
        'DirectoryServiceDomainName': 'string',
        'DomainControllers': [
            {
                'Hostname': 'string',
                'IPAddress': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'PrivateAddress': 'string'
        },
        'MasterUsername': 'string',
        'NASInstanceClass': 'string',
        'NASInstanceDescription': 'string',
        'NASInstanceErrorInfo': {
            'NASInstanceErrorCode': 'string',
            'NASInstanceErrorMessage': 'string'
        },
        'NASInstanceIdentifier': 'string',
        'NASInstanceStatus': 'string',
        'NASInstanceType': 123,
        'NASSecurityGroups': [
            {
                'NASSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'NetworkId': 'string',
        'NoRootSquash': True|False,
        'Protocol': 'string',
        'StorageType': 123,
        'UpgradeRequired': True|False
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASInstance (dict) –
  - AllocatedStorage (integer) –
  - AuthenticationType (integer) –
  - AvailabilityZone (string) –
  - DirectoryServiceDomainName (string) –
  - DomainControllers (list) –
    - (dict) –
      - Hostname (string) –
      - IPAddress (string) –
  - Endpoint (dict) –
    - Address (string) –
    - PrivateAddress (string) –
  - MasterUsername (string) –
  - NASInstanceClass (string) –
  - NASInstanceDescription (string) –
  - NASInstanceErrorInfo (dict) –
    - NASInstanceErrorCode (string) –
    - NASInstanceErrorMessage (string) –
  - NASInstanceIdentifier (string) –
  - NASInstanceStatus (string) –
  - NASInstanceType (integer) –
  - NASSecurityGroups (list) –
    - (dict) –
      - NASSecurityGroupName (string) –
      - Status (string) –
  - NetworkId (string) –
  - NoRootSquash (boolean) –
  - Protocol (string) –
  - StorageType (integer) –
  - UpgradeRequired (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_nas_security_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_nas_security_group(
    AvailabilityZone='string',
    NASSecurityGroupDescription='string',
    NASSecurityGroupName='string'
)

Parameters:

AvailabilityZone (string) – [REQUIRED]
NASSecurityGroupDescription (string) –
NASSecurityGroupName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NASSecurityGroup': {
        'AvailabilityZone': 'string',
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NASSecurityGroupDescription': 'string',
        'NASSecurityGroupName': 'string',
        'OwnerId': 'string',
        'SecurityGroups': [
            {
                'SecurityGroupName': 'string',
                'SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASSecurityGroup (dict) –
  - AvailabilityZone (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NASSecurityGroupDescription (string) –
  - NASSecurityGroupName (string) –
  - OwnerId (string) –
  - SecurityGroups (list) –
    - (dict) –
      - SecurityGroupName (string) –
      - SecurityGroupOwnerId (string) –
      - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_nas_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_nas_instance(
    DirectoryServiceAdministratorName='string',
    DirectoryServiceAdministratorPassword='string',
    NASInstanceIdentifier='string'
)

Parameters:

DirectoryServiceAdministratorName (string) –
DirectoryServiceAdministratorPassword (string) –
NASInstanceIdentifier (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NASInstance': {
        'AllocatedStorage': 123,
        'AuthenticationType': 123,
        'AvailabilityZone': 'string',
        'DirectoryServiceDomainName': 'string',
        'DomainControllers': [
            {
                'Hostname': 'string',
                'IPAddress': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'PrivateAddress': 'string'
        },
        'MasterUsername': 'string',
        'NASInstanceClass': 'string',
        'NASInstanceDescription': 'string',
        'NASInstanceErrorInfo': {
            'NASInstanceErrorCode': 'string',
            'NASInstanceErrorMessage': 'string'
        },
        'NASInstanceIdentifier': 'string',
        'NASInstanceStatus': 'string',
        'NASInstanceType': 123,
        'NASSecurityGroups': [
            {
                'NASSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'NetworkId': 'string',
        'NoRootSquash': True|False,
        'Protocol': 'string',
        'StorageType': 123,
        'UpgradeRequired': True|False
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASInstance (dict) –
  - AllocatedStorage (integer) –
  - AuthenticationType (integer) –
  - AvailabilityZone (string) –
  - DirectoryServiceDomainName (string) –
  - DomainControllers (list) –
    - (dict) –
      - Hostname (string) –
      - IPAddress (string) –
  - Endpoint (dict) –
    - Address (string) –
    - PrivateAddress (string) –
  - MasterUsername (string) –
  - NASInstanceClass (string) –
  - NASInstanceDescription (string) –
  - NASInstanceErrorInfo (dict) –
    - NASInstanceErrorCode (string) –
    - NASInstanceErrorMessage (string) –
  - NASInstanceIdentifier (string) –
  - NASInstanceStatus (string) –
  - NASInstanceType (integer) –
  - NASSecurityGroups (list) –
    - (dict) –
      - NASSecurityGroupName (string) –
      - Status (string) –
  - NetworkId (string) –
  - NoRootSquash (boolean) –
  - Protocol (string) –
  - StorageType (integer) –
  - UpgradeRequired (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_nas_security_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_nas_security_group(
    NASSecurityGroupName='string'
)

Parameters: NASSecurityGroupName (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_nas_instances(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_nas_instances(
    NASInstanceIdentifier='string'
)

Parameters: NASInstanceIdentifier (string) –

Return type: dict

Returns:

Response Syntax

{
    'NASInstances': [
        {
            'AllocatedStorage': 123,
            'AuthenticationType': 123,
            'AvailabilityZone': 'string',
            'DirectoryServiceDomainName': 'string',
            'DomainControllers': [
                {
                    'Hostname': 'string',
                    'IPAddress': 'string'
                },
            ],
            'Endpoint': {
                'Address': 'string',
                'PrivateAddress': 'string'
            },
            'MasterUsername': 'string',
            'NASInstanceClass': 'string',
            'NASInstanceDescription': 'string',
            'NASInstanceErrorInfo': {
                'NASInstanceErrorCode': 'string',
                'NASInstanceErrorMessage': 'string'
            },
            'NASInstanceIdentifier': 'string',
            'NASInstanceStatus': 'string',
            'NASInstanceType': 123,
            'NASSecurityGroups': [
                {
                    'NASSecurityGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'NetworkId': 'string',
            'NoRootSquash': True|False,
            'Protocol': 'string',
            'StorageType': 123,
            'UpgradeRequired': True|False
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASInstances (list) –
  - (dict) –
    - AllocatedStorage (integer) –
    - AuthenticationType (integer) –
    - AvailabilityZone (string) –
    - DirectoryServiceDomainName (string) –
    - DomainControllers (list) –
      - (dict) –
        
        Hostname (string) –
        
        IPAddress (string) –
    - Endpoint (dict) –
      - Address (string) –
      - PrivateAddress (string) –
    - MasterUsername (string) –
    - NASInstanceClass (string) –
    - NASInstanceDescription (string) –
    - NASInstanceErrorInfo (dict) –
      - NASInstanceErrorCode (string) –
      - NASInstanceErrorMessage (string) –
    - NASInstanceIdentifier (string) –
    - NASInstanceStatus (string) –
    - NASInstanceType (integer) –
    - NASSecurityGroups (list) –
      - (dict) –
        
        NASSecurityGroupName (string) –
        
        Status (string) –
    - NetworkId (string) –
    - NoRootSquash (boolean) –
    - Protocol (string) –
    - StorageType (integer) –
    - UpgradeRequired (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_nas_security_groups(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_nas_security_groups(
    NASSecurityGroupName='string'
)

Parameters: NASSecurityGroupName (string) –

Return type: dict

Returns:

Response Syntax

{
    'NASSecurityGroups': [
        {
            'AvailabilityZone': 'string',
            'IPRanges': [
                {
                    'CIDRIP': 'string',
                    'Status': 'string'
                },
            ],
            'NASSecurityGroupDescription': 'string',
            'NASSecurityGroupName': 'string',
            'OwnerId': 'string',
            'SecurityGroups': [
                {
                    'SecurityGroupName': 'string',
                    'SecurityGroupOwnerId': 'string',
                    'Status': 'string'
                },
            ]
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASSecurityGroups (list) –
  - (dict) –
    - AvailabilityZone (string) –
    - IPRanges (list) –
      - (dict) –
        
        CIDRIP (string) –
        
        Status (string) –
    - NASSecurityGroupDescription (string) –
    - NASSecurityGroupName (string) –
    - OwnerId (string) –
    - SecurityGroups (list) –
      - (dict) –
        
        SecurityGroupName (string) –
        
        SecurityGroupOwnerId (string) –
        
        Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters:

ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to ClientMethod.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.

Returns:

The presigned url

get_metric_statistics(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_metric_statistics(
    Dimensions=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    EndTime=datetime(2015, 1, 1),
    MetricName='FreeStorageSpace'|'UsedStorageSpace'|'ReadIOPS'|'WriteIOPS'|'ReadThroughput'|'WriteThroughput'|'ActiveConnections'|'GlobalReadTraffic'|'PrivateReadTraffic'|'GlobalWriteTraffic'|'PrivateWriteTraffic',
    StartTime=datetime(2015, 1, 1)
)

Parameters:

Dimensions (list) –
[REQUIRED]
- (dict) –
  - Name (string) – [REQUIRED]
  - Value (string) – [REQUIRED]
EndTime (datetime) –
MetricName (string) – [REQUIRED]
StartTime (datetime) –

Return type:

dict

Returns:

Response Syntax

{
    'Datapoints': [
        {
            'SampleCount': 123,
            'Sum': 123.0,
            'TargetName': 'string',
            'Timestamp': datetime(2015, 1, 1)
        },
    ],
    'Label': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- Datapoints (list) –
  - (dict) –
    - SampleCount (integer) –
    - Sum (float) –
    - TargetName (string) –
    - Timestamp (datetime) –
- Label (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Raises:	OperationNotPageableError – Raised if the operation is not pageable. You can use the `client.can_paginate` method to check if an operation is pageable.
Return type:	L{botocore.paginate.Paginator}
Returns:	A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters:	waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns:	The specified waiter object.
Return type:	botocore.waiter.Waiter

modify_nas_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_nas_instance(
    AllocatedStorage=123,
    AuthenticationType=123,
    DirectoryServiceAdministratorName='string',
    DirectoryServiceAdministratorPassword='string',
    DirectoryServiceDomainName='string',
    DomainControllers=[
        {
            'Hostname': 'string',
            'IPAddress': 'string'
        },
    ],
    MasterPrivateAddress='string',
    MasterUserPassword='string',
    NASInstanceDescription='string',
    NASInstanceIdentifier='string',
    NASSecurityGroups=[
        'string',
    ],
    NetworkId='string',
    NewNASInstanceIdentifier='string',
    NoRootSquash=True|False
)

Parameters:

AllocatedStorage (integer) –
AuthenticationType (integer) –
DirectoryServiceAdministratorName (string) –
DirectoryServiceAdministratorPassword (string) –
DirectoryServiceDomainName (string) –
DomainControllers (list) –
- (dict) –
  - Hostname (string) –
  - IPAddress (string) –
MasterPrivateAddress (string) –
MasterUserPassword (string) –
NASInstanceDescription (string) –
NASInstanceIdentifier (string) – [REQUIRED]
NASSecurityGroups (list) –
- (string) –
NetworkId (string) –
NewNASInstanceIdentifier (string) –
NoRootSquash (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'NASInstance': {
        'AllocatedStorage': 123,
        'AuthenticationType': 123,
        'AvailabilityZone': 'string',
        'DirectoryServiceDomainName': 'string',
        'DomainControllers': [
            {
                'Hostname': 'string',
                'IPAddress': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'PrivateAddress': 'string'
        },
        'MasterUsername': 'string',
        'NASInstanceClass': 'string',
        'NASInstanceDescription': 'string',
        'NASInstanceErrorInfo': {
            'NASInstanceErrorCode': 'string',
            'NASInstanceErrorMessage': 'string'
        },
        'NASInstanceIdentifier': 'string',
        'NASInstanceStatus': 'string',
        'NASInstanceType': 123,
        'NASSecurityGroups': [
            {
                'NASSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'NetworkId': 'string',
        'NoRootSquash': True|False,
        'Protocol': 'string',
        'StorageType': 123,
        'UpgradeRequired': True|False
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASInstance (dict) –
  - AllocatedStorage (integer) –
  - AuthenticationType (integer) –
  - AvailabilityZone (string) –
  - DirectoryServiceDomainName (string) –
  - DomainControllers (list) –
    - (dict) –
      - Hostname (string) –
      - IPAddress (string) –
  - Endpoint (dict) –
    - Address (string) –
    - PrivateAddress (string) –
  - MasterUsername (string) –
  - NASInstanceClass (string) –
  - NASInstanceDescription (string) –
  - NASInstanceErrorInfo (dict) –
    - NASInstanceErrorCode (string) –
    - NASInstanceErrorMessage (string) –
  - NASInstanceIdentifier (string) –
  - NASInstanceStatus (string) –
  - NASInstanceType (integer) –
  - NASSecurityGroups (list) –
    - (dict) –
      - NASSecurityGroupName (string) –
      - Status (string) –
  - NetworkId (string) –
  - NoRootSquash (boolean) –
  - Protocol (string) –
  - StorageType (integer) –
  - UpgradeRequired (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

modify_nas_security_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_nas_security_group(
    NASSecurityGroupDescription='string',
    NASSecurityGroupName='string',
    NewNASSecurityGroupName='string'
)

Parameters:

NASSecurityGroupDescription (string) –
NASSecurityGroupName (string) – [REQUIRED]
NewNASSecurityGroupName (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NASSecurityGroup': {
        'AvailabilityZone': 'string',
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NASSecurityGroupDescription': 'string',
        'NASSecurityGroupName': 'string',
        'OwnerId': 'string',
        'SecurityGroups': [
            {
                'SecurityGroupName': 'string',
                'SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASSecurityGroup (dict) –
  - AvailabilityZone (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NASSecurityGroupDescription (string) –
  - NASSecurityGroupName (string) –
  - OwnerId (string) –
  - SecurityGroups (list) –
    - (dict) –
      - SecurityGroupName (string) –
      - SecurityGroupOwnerId (string) –
      - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

revoke_nas_security_group_ingress(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.revoke_nas_security_group_ingress(
    CIDRIP='string',
    NASSecurityGroupName='string',
    SecurityGroupName='string'
)

Parameters:

CIDRIP (string) –
NASSecurityGroupName (string) – [REQUIRED]
SecurityGroupName (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NASSecurityGroup': {
        'AvailabilityZone': 'string',
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NASSecurityGroupDescription': 'string',
        'NASSecurityGroupName': 'string',
        'OwnerId': 'string',
        'SecurityGroups': [
            {
                'SecurityGroupName': 'string',
                'SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASSecurityGroup (dict) –
  - AvailabilityZone (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NASSecurityGroupDescription (string) –
  - NASSecurityGroupName (string) –
  - OwnerId (string) –
  - SecurityGroups (list) –
    - (dict) –
      - SecurityGroupName (string) –
      - SecurityGroupOwnerId (string) –
      - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

upgrade_nas_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.upgrade_nas_instance(
    NASInstanceIdentifier='string'
)

Parameters: NASInstanceIdentifier (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'NASInstance': {
        'AllocatedStorage': 123,
        'AuthenticationType': 123,
        'AvailabilityZone': 'string',
        'DirectoryServiceDomainName': 'string',
        'DomainControllers': [
            {
                'Hostname': 'string',
                'IPAddress': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'PrivateAddress': 'string'
        },
        'MasterUsername': 'string',
        'NASInstanceClass': 'string',
        'NASInstanceDescription': 'string',
        'NASInstanceErrorInfo': {
            'NASInstanceErrorCode': 'string',
            'NASInstanceErrorMessage': 'string'
        },
        'NASInstanceIdentifier': 'string',
        'NASInstanceStatus': 'string',
        'NASInstanceType': 123,
        'NASSecurityGroups': [
            {
                'NASSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'NetworkId': 'string',
        'NoRootSquash': True|False,
        'Protocol': 'string',
        'StorageType': 123,
        'UpgradeRequired': True|False
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NASInstance (dict) –
  - AllocatedStorage (integer) –
  - AuthenticationType (integer) –
  - AvailabilityZone (string) –
  - DirectoryServiceDomainName (string) –
  - DomainControllers (list) –
    - (dict) –
      - Hostname (string) –
      - IPAddress (string) –
  - Endpoint (dict) –
    - Address (string) –
    - PrivateAddress (string) –
  - MasterUsername (string) –
  - NASInstanceClass (string) –
  - NASInstanceDescription (string) –
  - NASInstanceErrorInfo (dict) –
    - NASInstanceErrorCode (string) –
    - NASInstanceErrorMessage (string) –
  - NASInstanceIdentifier (string) –
  - NASInstanceStatus (string) –
  - NASInstanceType (integer) –
  - NASSecurityGroups (list) –
    - (dict) –
      - NASSecurityGroupName (string) –
      - Status (string) –
  - NetworkId (string) –
  - NoRootSquash (boolean) –
  - Protocol (string) –
  - StorageType (integer) –
  - UpgradeRequired (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

This client has no modeled exception classes.

Waiters ¶

The available waiters are:

nas.Waiter.NASInstanceAvailable
nas.Waiter.NASInstanceDeleted
nas.Waiter.NASInstanceExists
nas.Waiter.NASInstanceFailed
nas.Waiter.NASInstanceStorageFull
nas.Waiter.NASSecurityGroupDeleted
nas.Waiter.NASSecurityGroupExists
nas.Waiter.NASSecurityGroupIPRangesAuthFailed
nas.Waiter.NASSecurityGroupIPRangesAuthorized
nas.Waiter.NASSecurityGroupIPRangesEmptied
nas.Waiter.NASSecurityGroupIPRangesRevokeFailed
nas.Waiter.NASSecurityGroupSecurityGroupsAuthFailed
nas.Waiter.NASSecurityGroupSecurityGroupsAuthorized
nas.Waiter.NASSecurityGroupSecurityGroupsEmptied
nas.Waiter.NASSecurityGroupSecurityGroupsRevokeFailed

class nas.Waiter.NASInstanceAvailable¶

waiter = client.get_waiter('nas_instance_available')

wait(**kwargs)¶

Polls nas.Client.describe_nas_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASInstanceIdentifier='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASInstanceIdentifier (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 40 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 80
Returns:	None

class nas.Waiter.NASInstanceDeleted¶

waiter = client.get_waiter('nas_instance_deleted')

wait(**kwargs)¶

Polls nas.Client.describe_nas_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASInstanceIdentifier='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASInstanceIdentifier (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 40 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 80
Returns:	None

class nas.Waiter.NASInstanceExists¶

waiter = client.get_waiter('nas_instance_exists')

wait(**kwargs)¶

Polls nas.Client.describe_nas_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASInstanceIdentifier='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASInstanceIdentifier (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 40 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 80
Returns:	None

class nas.Waiter.NASInstanceFailed¶

waiter = client.get_waiter('nas_instance_failed')

wait(**kwargs)¶

Polls nas.Client.describe_nas_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASInstanceIdentifier='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASInstanceIdentifier (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 40 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 80
Returns:	None

class nas.Waiter.NASInstanceStorageFull¶

waiter = client.get_waiter('nas_instance_storage_full')

wait(**kwargs)¶

Polls nas.Client.describe_nas_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASInstanceIdentifier='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASInstanceIdentifier (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 40 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 80
Returns:	None

class nas.Waiter.NASSecurityGroupDeleted¶

waiter = client.get_waiter('nas_security_group_deleted')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupExists¶

waiter = client.get_waiter('nas_security_group_exists')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupIPRangesAuthFailed¶

waiter = client.get_waiter('nas_security_group_ip_ranges_auth_failed')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupIPRangesAuthorized¶

waiter = client.get_waiter('nas_security_group_ip_ranges_authorized')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupIPRangesEmptied¶

waiter = client.get_waiter('nas_security_group_ip_ranges_emptied')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupIPRangesRevokeFailed¶

waiter = client.get_waiter('nas_security_group_ip_ranges_revoke_failed')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupSecurityGroupsAuthFailed¶

waiter = client.get_waiter('nas_security_group_security_groups_auth_failed')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupSecurityGroupsAuthorized¶

waiter = client.get_waiter('nas_security_group_security_groups_authorized')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupSecurityGroupsEmptied¶

waiter = client.get_waiter('nas_security_group_security_groups_emptied')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

class nas.Waiter.NASSecurityGroupSecurityGroupsRevokeFailed¶

waiter = client.get_waiter('nas_security_group_security_groups_revoke_failed')

wait(**kwargs)¶

Polls nas.Client.describe_nas_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    NASSecurityGroupName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:	NASSecurityGroupName (string) – WaiterConfig (dict) – A dictionary that provides parameters to control waiting behavior. Delay (integer) – The amount of time in seconds to wait between attempts. Default: 20 MaxAttempts (integer) – The maximum number of attempts to be made. Default: 40
Returns:	None

nas¶

Client¶

Client Exceptions¶

Waiters¶

nas ¶

Client ¶

Client Exceptions ¶

Waiters ¶