script

Table of Contents

Client

class script.Client

A low-level client representing NIFCLOUD Script:

client = session.create_client('script')

These are the available methods:

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.
execute_script(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.execute_script(
    Body='string',
    Header='string',
    Method='string',
    Query='string',
    ScriptIdentifier='string'
)
Parameters:
  • Body (string) –
  • Header (string) –
  • Method (string) –
  • Query (string) –
  • ScriptIdentifier (string) –
Return type:

dict

Returns:

Response Syntax

{
    'Result': {
        'RequestBody': 'string',
        'RequestHeader': 'string',
        'RequestQuery': 'string',
        'ResponseData': 'string',
        'ResponseHeader': 'string',
        'ResponseStatus': 123,
        'ScriptIdentifier': 'string'
    }
}

Response Structure

  • (dict) –
    • Result (dict) –
      • RequestBody (string) –
      • RequestHeader (string) –
      • RequestQuery (string) –
      • ResponseData (string) –
      • ResponseHeader (string) –
      • ResponseStatus (integer) –
      • ScriptIdentifier (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_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)