AmazonRedshift API Documentation

AcceptReservedNodeExchange

acceptReservedNodeExchange

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.


/AcceptReservedNodeExchange

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/AcceptReservedNodeExchange?ReservedNodeId=&TargetReservedNodeOfferingId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AcceptReservedNodeExchangeApi;

import java.io.File;
import java.util.*;

public class AcceptReservedNodeExchangeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        AcceptReservedNodeExchangeApi apiInstance = new AcceptReservedNodeExchangeApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeId = reservedNodeId_example; // String | A string representing the node identifier of the DC1 Reserved Node to be exchanged.
        String targetReservedNodeOfferingId = targetReservedNodeOfferingId_example; // String | The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling
        try {
            inline_response_200 result = apiInstance.acceptReservedNodeExchange(apiecoKey, reservedNodeId, targetReservedNodeOfferingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AcceptReservedNodeExchangeApi#acceptReservedNodeExchange");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AcceptReservedNodeExchangeApi;

public class AcceptReservedNodeExchangeApiExample {

    public static void main(String[] args) {
        AcceptReservedNodeExchangeApi apiInstance = new AcceptReservedNodeExchangeApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeId = reservedNodeId_example; // String | A string representing the node identifier of the DC1 Reserved Node to be exchanged.
        String targetReservedNodeOfferingId = targetReservedNodeOfferingId_example; // String | The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling
        try {
            inline_response_200 result = apiInstance.acceptReservedNodeExchange(apiecoKey, reservedNodeId, targetReservedNodeOfferingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AcceptReservedNodeExchangeApi#acceptReservedNodeExchange");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *reservedNodeId = reservedNodeId_example; // A string representing the node identifier of the DC1 Reserved Node to be exchanged.
String *targetReservedNodeOfferingId = targetReservedNodeOfferingId_example; // The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling

AcceptReservedNodeExchangeApi *apiInstance = [[AcceptReservedNodeExchangeApi alloc] init];

[apiInstance acceptReservedNodeExchangeWith:apiecoKey
    reservedNodeId:reservedNodeId
    targetReservedNodeOfferingId:targetReservedNodeOfferingId
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.AcceptReservedNodeExchangeApi()

var apiecoKey = apiecoKey_example; // {String} 

var reservedNodeId = reservedNodeId_example; // {String} A string representing the node identifier of the DC1 Reserved Node to be exchanged.

var targetReservedNodeOfferingId = targetReservedNodeOfferingId_example; // {String} The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.acceptReservedNodeExchange(apiecoKey, reservedNodeId, targetReservedNodeOfferingId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class acceptReservedNodeExchangeExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new AcceptReservedNodeExchangeApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var reservedNodeId = reservedNodeId_example;  // String | A string representing the node identifier of the DC1 Reserved Node to be exchanged.
            var targetReservedNodeOfferingId = targetReservedNodeOfferingId_example;  // String | The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling

            try
            {
                inline_response_200 result = apiInstance.acceptReservedNodeExchange(apiecoKey, reservedNodeId, targetReservedNodeOfferingId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AcceptReservedNodeExchangeApi.acceptReservedNodeExchange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\AcceptReservedNodeExchangeApi();
$apiecoKey = apiecoKey_example; // String | 
$reservedNodeId = reservedNodeId_example; // String | A string representing the node identifier of the DC1 Reserved Node to be exchanged.
$targetReservedNodeOfferingId = targetReservedNodeOfferingId_example; // String | The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling

try {
    $result = $api_instance->acceptReservedNodeExchange($apiecoKey, $reservedNodeId, $targetReservedNodeOfferingId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AcceptReservedNodeExchangeApi->acceptReservedNodeExchange: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AcceptReservedNodeExchangeApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AcceptReservedNodeExchangeApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $reservedNodeId = reservedNodeId_example; # String | A string representing the node identifier of the DC1 Reserved Node to be exchanged.
my $targetReservedNodeOfferingId = targetReservedNodeOfferingId_example; # String | The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling

eval { 
    my $result = $api_instance->acceptReservedNodeExchange(apiecoKey => $apiecoKey, reservedNodeId => $reservedNodeId, targetReservedNodeOfferingId => $targetReservedNodeOfferingId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AcceptReservedNodeExchangeApi->acceptReservedNodeExchange: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AcceptReservedNodeExchangeApi()
apiecoKey = apiecoKey_example # String | 
reservedNodeId = reservedNodeId_example # String | A string representing the node identifier of the DC1 Reserved Node to be exchanged.
targetReservedNodeOfferingId = targetReservedNodeOfferingId_example # String | The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling

try: 
    api_response = api_instance.accept_reserved_node_exchange(apiecoKey, reservedNodeId, targetReservedNodeOfferingId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AcceptReservedNodeExchangeApi->acceptReservedNodeExchange: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ReservedNodeId*
String
A string representing the node identifier of the DC1 Reserved Node to be exchanged.
Required
TargetReservedNodeOfferingId*
String
The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


AuthorizeClusterSecurityGroupIngress

authorizeClusterSecurityGroupIngress

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.


/AuthorizeClusterSecurityGroupIngress

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/AuthorizeClusterSecurityGroupIngress?ClusterSecurityGroupName=&CIDRIP=&EC2SecurityGroupName=&EC2SecurityGroupOwnerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthorizeClusterSecurityGroupIngressApi;

import java.io.File;
import java.util.*;

public class AuthorizeClusterSecurityGroupIngressApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        AuthorizeClusterSecurityGroupIngressApi apiInstance = new AuthorizeClusterSecurityGroupIngressApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of the security group to which the ingress rule is added.

        String cIDRIP = cIDRIP_example; // String | The IP range to be added the Amazon Redshift security group.
        String eC2SecurityGroupName = eC2SecurityGroupName_example; // String | The EC2 security group to be added the Amazon Redshift security group.

        String eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // String | The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
        try {
            inline_response_200_1 result = apiInstance.authorizeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, cIDRIP, eC2SecurityGroupName, eC2SecurityGroupOwnerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizeClusterSecurityGroupIngressApi#authorizeClusterSecurityGroupIngress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthorizeClusterSecurityGroupIngressApi;

public class AuthorizeClusterSecurityGroupIngressApiExample {

    public static void main(String[] args) {
        AuthorizeClusterSecurityGroupIngressApi apiInstance = new AuthorizeClusterSecurityGroupIngressApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of the security group to which the ingress rule is added.

        String cIDRIP = cIDRIP_example; // String | The IP range to be added the Amazon Redshift security group.
        String eC2SecurityGroupName = eC2SecurityGroupName_example; // String | The EC2 security group to be added the Amazon Redshift security group.

        String eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // String | The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
        try {
            inline_response_200_1 result = apiInstance.authorizeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, cIDRIP, eC2SecurityGroupName, eC2SecurityGroupOwnerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizeClusterSecurityGroupIngressApi#authorizeClusterSecurityGroupIngress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterSecurityGroupName = clusterSecurityGroupName_example; // The name of the security group to which the ingress rule is added.

String *cIDRIP = cIDRIP_example; // The IP range to be added the Amazon Redshift security group. (optional)
String *eC2SecurityGroupName = eC2SecurityGroupName_example; // The EC2 security group to be added the Amazon Redshift security group.
 (optional)
String *eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333 (optional)

AuthorizeClusterSecurityGroupIngressApi *apiInstance = [[AuthorizeClusterSecurityGroupIngressApi alloc] init];

[apiInstance authorizeClusterSecurityGroupIngressWith:apiecoKey
    clusterSecurityGroupName:clusterSecurityGroupName
    cIDRIP:cIDRIP
    eC2SecurityGroupName:eC2SecurityGroupName
    eC2SecurityGroupOwnerId:eC2SecurityGroupOwnerId
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.AuthorizeClusterSecurityGroupIngressApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterSecurityGroupName = clusterSecurityGroupName_example; // {String} The name of the security group to which the ingress rule is added.


var opts = { 
  'cIDRIP': cIDRIP_example, // {String} The IP range to be added the Amazon Redshift security group.
  'eC2SecurityGroupName': eC2SecurityGroupName_example, // {String} The EC2 security group to be added the Amazon Redshift security group.

  'eC2SecurityGroupOwnerId': eC2SecurityGroupOwnerId_example // {String} The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authorizeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authorizeClusterSecurityGroupIngressExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new AuthorizeClusterSecurityGroupIngressApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSecurityGroupName = clusterSecurityGroupName_example;  // String | The name of the security group to which the ingress rule is added.

            var cIDRIP = cIDRIP_example;  // String | The IP range to be added the Amazon Redshift security group. (optional) 
            var eC2SecurityGroupName = eC2SecurityGroupName_example;  // String | The EC2 security group to be added the Amazon Redshift security group.
 (optional) 
            var eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example;  // String | The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333 (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.authorizeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, cIDRIP, eC2SecurityGroupName, eC2SecurityGroupOwnerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorizeClusterSecurityGroupIngressApi.authorizeClusterSecurityGroupIngress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\AuthorizeClusterSecurityGroupIngressApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of the security group to which the ingress rule is added.

$cIDRIP = cIDRIP_example; // String | The IP range to be added the Amazon Redshift security group.
$eC2SecurityGroupName = eC2SecurityGroupName_example; // String | The EC2 security group to be added the Amazon Redshift security group.

$eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // String | The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333

try {
    $result = $api_instance->authorizeClusterSecurityGroupIngress($apiecoKey, $clusterSecurityGroupName, $cIDRIP, $eC2SecurityGroupName, $eC2SecurityGroupOwnerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizeClusterSecurityGroupIngressApi->authorizeClusterSecurityGroupIngress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorizeClusterSecurityGroupIngressApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthorizeClusterSecurityGroupIngressApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSecurityGroupName = clusterSecurityGroupName_example; # String | The name of the security group to which the ingress rule is added.

my $cIDRIP = cIDRIP_example; # String | The IP range to be added the Amazon Redshift security group.
my $eC2SecurityGroupName = eC2SecurityGroupName_example; # String | The EC2 security group to be added the Amazon Redshift security group.

my $eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; # String | The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333

eval { 
    my $result = $api_instance->authorizeClusterSecurityGroupIngress(apiecoKey => $apiecoKey, clusterSecurityGroupName => $clusterSecurityGroupName, cIDRIP => $cIDRIP, eC2SecurityGroupName => $eC2SecurityGroupName, eC2SecurityGroupOwnerId => $eC2SecurityGroupOwnerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizeClusterSecurityGroupIngressApi->authorizeClusterSecurityGroupIngress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthorizeClusterSecurityGroupIngressApi()
apiecoKey = apiecoKey_example # String | 
clusterSecurityGroupName = clusterSecurityGroupName_example # String | The name of the security group to which the ingress rule is added.

cIDRIP = cIDRIP_example # String | The IP range to be added the Amazon Redshift security group. (optional)
eC2SecurityGroupName = eC2SecurityGroupName_example # String | The EC2 security group to be added the Amazon Redshift security group.
 (optional)
eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example # String | The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333 (optional)

try: 
    api_response = api_instance.authorize_cluster_security_group_ingress(apiecoKey, clusterSecurityGroupName, cIDRIP=cIDRIP, eC2SecurityGroupName=eC2SecurityGroupName, eC2SecurityGroupOwnerId=eC2SecurityGroupOwnerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizeClusterSecurityGroupIngressApi->authorizeClusterSecurityGroupIngress: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSecurityGroupName*
String
The name of the security group to which the ingress rule is added.
Required
CIDRIP
String
The IP range to be added the Amazon Redshift security group.
EC2SecurityGroupName
String
The EC2 security group to be added the Amazon Redshift security group.
EC2SecurityGroupOwnerId
String
The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: 111122223333

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


AuthorizeSnapshotAccess

authorizeSnapshotAccess

AAuthorizes the specified AWS customer account to restore the specified snapshot. For more information about working with snapshots, go to Amazon Re


/AuthorizeSnapshotAccess

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/AuthorizeSnapshotAccess?AccountWithRestoreAccess=&SnapshotIdentifier=&SnapshotClusterIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthorizeSnapshotAccessApi;

import java.io.File;
import java.util.*;

public class AuthorizeSnapshotAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        AuthorizeSnapshotAccessApi apiInstance = new AuthorizeSnapshotAccessApi();
        String apiecoKey = apiecoKey_example; // String | 
        String accountWithRestoreAccess = accountWithRestoreAccess_example; // String | The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot the account is authorized to restore.
        String snapshotClusterIdentifier = snapshotClusterIdentifier_example; // String | The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

        try {
            inline_response_200_2 result = apiInstance.authorizeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizeSnapshotAccessApi#authorizeSnapshotAccess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthorizeSnapshotAccessApi;

public class AuthorizeSnapshotAccessApiExample {

    public static void main(String[] args) {
        AuthorizeSnapshotAccessApi apiInstance = new AuthorizeSnapshotAccessApi();
        String apiecoKey = apiecoKey_example; // String | 
        String accountWithRestoreAccess = accountWithRestoreAccess_example; // String | The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot the account is authorized to restore.
        String snapshotClusterIdentifier = snapshotClusterIdentifier_example; // String | The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

        try {
            inline_response_200_2 result = apiInstance.authorizeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizeSnapshotAccessApi#authorizeSnapshotAccess");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *accountWithRestoreAccess = accountWithRestoreAccess_example; // The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

String *snapshotIdentifier = snapshotIdentifier_example; // The identifier of the snapshot the account is authorized to restore.
String *snapshotClusterIdentifier = snapshotClusterIdentifier_example; // The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
 (optional)

AuthorizeSnapshotAccessApi *apiInstance = [[AuthorizeSnapshotAccessApi alloc] init];

[apiInstance authorizeSnapshotAccessWith:apiecoKey
    accountWithRestoreAccess:accountWithRestoreAccess
    snapshotIdentifier:snapshotIdentifier
    snapshotClusterIdentifier:snapshotClusterIdentifier
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.AuthorizeSnapshotAccessApi()

var apiecoKey = apiecoKey_example; // {String} 

var accountWithRestoreAccess = accountWithRestoreAccess_example; // {String} The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.


var snapshotIdentifier = snapshotIdentifier_example; // {String} The identifier of the snapshot the account is authorized to restore.

var opts = { 
  'snapshotClusterIdentifier': snapshotClusterIdentifier_example // {String} The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authorizeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authorizeSnapshotAccessExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new AuthorizeSnapshotAccessApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var accountWithRestoreAccess = accountWithRestoreAccess_example;  // String | The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

            var snapshotIdentifier = snapshotIdentifier_example;  // String | The identifier of the snapshot the account is authorized to restore.
            var snapshotClusterIdentifier = snapshotClusterIdentifier_example;  // String | The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
 (optional) 

            try
            {
                inline_response_200_2 result = apiInstance.authorizeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorizeSnapshotAccessApi.authorizeSnapshotAccess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\AuthorizeSnapshotAccessApi();
$apiecoKey = apiecoKey_example; // String | 
$accountWithRestoreAccess = accountWithRestoreAccess_example; // String | The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

$snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot the account is authorized to restore.
$snapshotClusterIdentifier = snapshotClusterIdentifier_example; // String | The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.


try {
    $result = $api_instance->authorizeSnapshotAccess($apiecoKey, $accountWithRestoreAccess, $snapshotIdentifier, $snapshotClusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizeSnapshotAccessApi->authorizeSnapshotAccess: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorizeSnapshotAccessApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthorizeSnapshotAccessApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $accountWithRestoreAccess = accountWithRestoreAccess_example; # String | The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

my $snapshotIdentifier = snapshotIdentifier_example; # String | The identifier of the snapshot the account is authorized to restore.
my $snapshotClusterIdentifier = snapshotClusterIdentifier_example; # String | The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.


eval { 
    my $result = $api_instance->authorizeSnapshotAccess(apiecoKey => $apiecoKey, accountWithRestoreAccess => $accountWithRestoreAccess, snapshotIdentifier => $snapshotIdentifier, snapshotClusterIdentifier => $snapshotClusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizeSnapshotAccessApi->authorizeSnapshotAccess: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthorizeSnapshotAccessApi()
apiecoKey = apiecoKey_example # String | 
accountWithRestoreAccess = accountWithRestoreAccess_example # String | The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.

snapshotIdentifier = snapshotIdentifier_example # String | The identifier of the snapshot the account is authorized to restore.
snapshotClusterIdentifier = snapshotClusterIdentifier_example # String | The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
 (optional)

try: 
    api_response = api_instance.authorize_snapshot_access(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier=snapshotClusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizeSnapshotAccessApi->authorizeSnapshotAccess: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
AccountWithRestoreAccess*
String
The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support.
Required
SnapshotIdentifier*
String
The identifier of the snapshot the account is authorized to restore.
Required
SnapshotClusterIdentifier
String
The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


BatchDeleteClusterSnapshots

batchDeleteClusterSnapshots

Deletes a set of cluster snapshots.


/BatchDeleteClusterSnapshots

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/BatchDeleteClusterSnapshots?Identifiers.DeleteClusterSnapshotMessage.N=&Errors.SnapshotErrorMessage.N =&Resources.String.N ="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BatchDeleteClusterSnapshotsApi;

import java.io.File;
import java.util.*;

public class BatchDeleteClusterSnapshotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        BatchDeleteClusterSnapshotsApi apiInstance = new BatchDeleteClusterSnapshotsApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] identifiers.DeleteClusterSnapshotMessage.N = ; // array[String] | A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


        array[String] errors.SnapshotErrorMessage.N  = ; // array[String] | A list of any errors returned.
Type: Array of SnapshotErrorMessage objects
        array[String] resources.String.N  = ; // array[String] | A list of the snapshot identifiers that were deleted.



        try {
            inline_response_200_3 result = apiInstance.batchDeleteClusterSnapshots(apiecoKey, identifiers.DeleteClusterSnapshotMessage.N, errors.SnapshotErrorMessage.N , resources.String.N );
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BatchDeleteClusterSnapshotsApi#batchDeleteClusterSnapshots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BatchDeleteClusterSnapshotsApi;

public class BatchDeleteClusterSnapshotsApiExample {

    public static void main(String[] args) {
        BatchDeleteClusterSnapshotsApi apiInstance = new BatchDeleteClusterSnapshotsApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] identifiers.DeleteClusterSnapshotMessage.N = ; // array[String] | A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


        array[String] errors.SnapshotErrorMessage.N  = ; // array[String] | A list of any errors returned.
Type: Array of SnapshotErrorMessage objects
        array[String] resources.String.N  = ; // array[String] | A list of the snapshot identifiers that were deleted.



        try {
            inline_response_200_3 result = apiInstance.batchDeleteClusterSnapshots(apiecoKey, identifiers.DeleteClusterSnapshotMessage.N, errors.SnapshotErrorMessage.N , resources.String.N );
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BatchDeleteClusterSnapshotsApi#batchDeleteClusterSnapshots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
array[String] *identifiers.DeleteClusterSnapshotMessage.N = ; // A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


array[String] *errors.SnapshotErrorMessage.N  = ; // A list of any errors returned.
Type: Array of SnapshotErrorMessage objects (optional)
array[String] *resources.String.N  = ; // A list of the snapshot identifiers that were deleted.


 (optional)

BatchDeleteClusterSnapshotsApi *apiInstance = [[BatchDeleteClusterSnapshotsApi alloc] init];

[apiInstance batchDeleteClusterSnapshotsWith:apiecoKey
    identifiers.DeleteClusterSnapshotMessage.N:identifiers.DeleteClusterSnapshotMessage.N
    errors.SnapshotErrorMessage.N :errors.SnapshotErrorMessage.N 
    resources.String.N :resources.String.N 
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.BatchDeleteClusterSnapshotsApi()

var apiecoKey = apiecoKey_example; // {String} 

var identifiers.DeleteClusterSnapshotMessage.N = ; // {array[String]} A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects



var opts = { 
  'errors.SnapshotErrorMessage.N ': , // {array[String]} A list of any errors returned.
Type: Array of SnapshotErrorMessage objects
  'resources.String.N ':  // {array[String]} A list of the snapshot identifiers that were deleted.



};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchDeleteClusterSnapshots(apiecoKey, identifiers.DeleteClusterSnapshotMessage.N, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class batchDeleteClusterSnapshotsExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new BatchDeleteClusterSnapshotsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var identifiers.DeleteClusterSnapshotMessage.N = new array[String](); // array[String] | A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


            var errors.SnapshotErrorMessage.N  = new array[String](); // array[String] | A list of any errors returned.
Type: Array of SnapshotErrorMessage objects (optional) 
            var resources.String.N  = new array[String](); // array[String] | A list of the snapshot identifiers that were deleted.


 (optional) 

            try
            {
                inline_response_200_3 result = apiInstance.batchDeleteClusterSnapshots(apiecoKey, identifiers.DeleteClusterSnapshotMessage.N, errors.SnapshotErrorMessage.N , resources.String.N );
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BatchDeleteClusterSnapshotsApi.batchDeleteClusterSnapshots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\BatchDeleteClusterSnapshotsApi();
$apiecoKey = apiecoKey_example; // String | 
$identifiers.DeleteClusterSnapshotMessage.N = ; // array[String] | A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


$errors.SnapshotErrorMessage.N  = ; // array[String] | A list of any errors returned.
Type: Array of SnapshotErrorMessage objects
$resources.String.N  = ; // array[String] | A list of the snapshot identifiers that were deleted.




try {
    $result = $api_instance->batchDeleteClusterSnapshots($apiecoKey, $identifiers.DeleteClusterSnapshotMessage.N, $errors.SnapshotErrorMessage.N , $resources.String.N );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BatchDeleteClusterSnapshotsApi->batchDeleteClusterSnapshots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BatchDeleteClusterSnapshotsApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BatchDeleteClusterSnapshotsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $identifiers.DeleteClusterSnapshotMessage.N = []; # array[String] | A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


my $errors.SnapshotErrorMessage.N  = []; # array[String] | A list of any errors returned.
Type: Array of SnapshotErrorMessage objects
my $resources.String.N  = []; # array[String] | A list of the snapshot identifiers that were deleted.




eval { 
    my $result = $api_instance->batchDeleteClusterSnapshots(apiecoKey => $apiecoKey, identifiers.DeleteClusterSnapshotMessage.N => $identifiers.DeleteClusterSnapshotMessage.N, errors.SnapshotErrorMessage.N  => $errors.SnapshotErrorMessage.N , resources.String.N  => $resources.String.N );
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BatchDeleteClusterSnapshotsApi->batchDeleteClusterSnapshots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BatchDeleteClusterSnapshotsApi()
apiecoKey = apiecoKey_example # String | 
identifiers.DeleteClusterSnapshotMessage.N =  # array[String] | A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects


errors.SnapshotErrorMessage.N  =  # array[String] | A list of any errors returned.
Type: Array of SnapshotErrorMessage objects (optional)
resources.String.N  =  # array[String] | A list of the snapshot identifiers that were deleted.


 (optional)

try: 
    api_response = api_instance.batch_delete_cluster_snapshots(apiecoKey, identifiers.DeleteClusterSnapshotMessage.N, errors.SnapshotErrorMessage.N =errors.SnapshotErrorMessage.N , resources.String.N =resources.String.N )
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchDeleteClusterSnapshotsApi->batchDeleteClusterSnapshots: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
Identifiers.DeleteClusterSnapshotMessage.N*
array[String]
A list of identifiers for the snapshots that you want to delete. Type: Array of DeleteClusterSnapshotMessage objects
Required
Errors.SnapshotErrorMessage.N
array[String]
A list of any errors returned. Type: Array of SnapshotErrorMessage objects
Resources.String.N
array[String]
A list of the snapshot identifiers that were deleted.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


BatchModifyClusterSnapshots

batchModifyClusterSnapshots

Modifies the settings for a set of cluster snapshots.


/BatchModifyClusterSnapshots

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/BatchModifyClusterSnapshots?SnapshotIdentifierList.String.N =&Force=&ManualSnapshotRetentionPeriod="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BatchModifyClusterSnapshotsApi;

import java.io.File;
import java.util.*;

public class BatchModifyClusterSnapshotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        BatchModifyClusterSnapshotsApi apiInstance = new BatchModifyClusterSnapshotsApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] snapshotIdentifierList.String.N  = ; // array[String] | TA list of snapshot identifiers you want to modify.



        Boolean force = true; // Boolean | TA boolean value indicating whether to override an exception if the retention period has passed.
        Integer manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.

        try {
            inline_response_200_4 result = apiInstance.batchModifyClusterSnapshots(apiecoKey, snapshotIdentifierList.String.N , force, manualSnapshotRetentionPeriod);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BatchModifyClusterSnapshotsApi#batchModifyClusterSnapshots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BatchModifyClusterSnapshotsApi;

public class BatchModifyClusterSnapshotsApiExample {

    public static void main(String[] args) {
        BatchModifyClusterSnapshotsApi apiInstance = new BatchModifyClusterSnapshotsApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] snapshotIdentifierList.String.N  = ; // array[String] | TA list of snapshot identifiers you want to modify.



        Boolean force = true; // Boolean | TA boolean value indicating whether to override an exception if the retention period has passed.
        Integer manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.

        try {
            inline_response_200_4 result = apiInstance.batchModifyClusterSnapshots(apiecoKey, snapshotIdentifierList.String.N , force, manualSnapshotRetentionPeriod);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BatchModifyClusterSnapshotsApi#batchModifyClusterSnapshots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
array[String] *snapshotIdentifierList.String.N  = ; // TA list of snapshot identifiers you want to modify.



Boolean *force = true; // TA boolean value indicating whether to override an exception if the retention period has passed. (optional)
Integer *manualSnapshotRetentionPeriod = 56; // The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.
 (optional)

BatchModifyClusterSnapshotsApi *apiInstance = [[BatchModifyClusterSnapshotsApi alloc] init];

[apiInstance batchModifyClusterSnapshotsWith:apiecoKey
    snapshotIdentifierList.String.N :snapshotIdentifierList.String.N 
    force:force
    manualSnapshotRetentionPeriod:manualSnapshotRetentionPeriod
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.BatchModifyClusterSnapshotsApi()

var apiecoKey = apiecoKey_example; // {String} 

var snapshotIdentifierList.String.N  = ; // {array[String]} TA list of snapshot identifiers you want to modify.




var opts = { 
  'force': true, // {Boolean} TA boolean value indicating whether to override an exception if the retention period has passed.
  'manualSnapshotRetentionPeriod': 56 // {Integer} The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchModifyClusterSnapshots(apiecoKey, snapshotIdentifierList.String.N , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class batchModifyClusterSnapshotsExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new BatchModifyClusterSnapshotsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var snapshotIdentifierList.String.N  = new array[String](); // array[String] | TA list of snapshot identifiers you want to modify.



            var force = true;  // Boolean | TA boolean value indicating whether to override an exception if the retention period has passed. (optional) 
            var manualSnapshotRetentionPeriod = 56;  // Integer | The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.
 (optional) 

            try
            {
                inline_response_200_4 result = apiInstance.batchModifyClusterSnapshots(apiecoKey, snapshotIdentifierList.String.N , force, manualSnapshotRetentionPeriod);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BatchModifyClusterSnapshotsApi.batchModifyClusterSnapshots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\BatchModifyClusterSnapshotsApi();
$apiecoKey = apiecoKey_example; // String | 
$snapshotIdentifierList.String.N  = ; // array[String] | TA list of snapshot identifiers you want to modify.



$force = true; // Boolean | TA boolean value indicating whether to override an exception if the retention period has passed.
$manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.


try {
    $result = $api_instance->batchModifyClusterSnapshots($apiecoKey, $snapshotIdentifierList.String.N , $force, $manualSnapshotRetentionPeriod);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BatchModifyClusterSnapshotsApi->batchModifyClusterSnapshots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BatchModifyClusterSnapshotsApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BatchModifyClusterSnapshotsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $snapshotIdentifierList.String.N  = []; # array[String] | TA list of snapshot identifiers you want to modify.



my $force = true; # Boolean | TA boolean value indicating whether to override an exception if the retention period has passed.
my $manualSnapshotRetentionPeriod = 56; # Integer | The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.


eval { 
    my $result = $api_instance->batchModifyClusterSnapshots(apiecoKey => $apiecoKey, snapshotIdentifierList.String.N  => $snapshotIdentifierList.String.N , force => $force, manualSnapshotRetentionPeriod => $manualSnapshotRetentionPeriod);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BatchModifyClusterSnapshotsApi->batchModifyClusterSnapshots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BatchModifyClusterSnapshotsApi()
apiecoKey = apiecoKey_example # String | 
snapshotIdentifierList.String.N  =  # array[String] | TA list of snapshot identifiers you want to modify.



force = true # Boolean | TA boolean value indicating whether to override an exception if the retention period has passed. (optional)
manualSnapshotRetentionPeriod = 56 # Integer | The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value,          existing manual snapshots that fall outside of the new retention period will         return an error. If you want to suppress the errors and delete the snapshots         , use the force option.
 (optional)

try: 
    api_response = api_instance.batch_modify_cluster_snapshots(apiecoKey, snapshotIdentifierList.String.N , force=force, manualSnapshotRetentionPeriod=manualSnapshotRetentionPeriod)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchModifyClusterSnapshotsApi->batchModifyClusterSnapshots: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SnapshotIdentifierList.String.N *
array[String]
TA list of snapshot identifiers you want to modify.
Required
Force
Boolean
TA boolean value indicating whether to override an exception if the retention period has passed.
ManualSnapshotRetentionPeriod
Integer
The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots , use the force option.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CancelResize

cancelResize

Cancels a resize operation for a cluster.


/CancelResize

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CancelResize?ClusterIdentifier ="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CancelResizeApi;

import java.io.File;
import java.util.*;

public class CancelResizeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CancelResizeApi apiInstance = new CancelResizeApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier  = clusterIdentifier _example; // String | The unique identifier for the cluster that you want to cancel a resize operation for.



        try {
            inline_response_200_5 result = apiInstance.cancelResize(apiecoKey, clusterIdentifier );
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CancelResizeApi#cancelResize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CancelResizeApi;

public class CancelResizeApiExample {

    public static void main(String[] args) {
        CancelResizeApi apiInstance = new CancelResizeApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier  = clusterIdentifier _example; // String | The unique identifier for the cluster that you want to cancel a resize operation for.



        try {
            inline_response_200_5 result = apiInstance.cancelResize(apiecoKey, clusterIdentifier );
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CancelResizeApi#cancelResize");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterIdentifier  = clusterIdentifier _example; // The unique identifier for the cluster that you want to cancel a resize operation for.




CancelResizeApi *apiInstance = [[CancelResizeApi alloc] init];

[apiInstance cancelResizeWith:apiecoKey
    clusterIdentifier :clusterIdentifier 
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CancelResizeApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier  = clusterIdentifier _example; // {String} The unique identifier for the cluster that you want to cancel a resize operation for.





var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelResize(apiecoKey, clusterIdentifier , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelResizeExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CancelResizeApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier  = clusterIdentifier _example;  // String | The unique identifier for the cluster that you want to cancel a resize operation for.




            try
            {
                inline_response_200_5 result = apiInstance.cancelResize(apiecoKey, clusterIdentifier );
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CancelResizeApi.cancelResize: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CancelResizeApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier  = clusterIdentifier _example; // String | The unique identifier for the cluster that you want to cancel a resize operation for.




try {
    $result = $api_instance->cancelResize($apiecoKey, $clusterIdentifier );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CancelResizeApi->cancelResize: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CancelResizeApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CancelResizeApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier  = clusterIdentifier _example; # String | The unique identifier for the cluster that you want to cancel a resize operation for.




eval { 
    my $result = $api_instance->cancelResize(apiecoKey => $apiecoKey, clusterIdentifier  => $clusterIdentifier );
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CancelResizeApi->cancelResize: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CancelResizeApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier  = clusterIdentifier _example # String | The unique identifier for the cluster that you want to cancel a resize operation for.




try: 
    api_response = api_instance.cancel_resize(apiecoKey, clusterIdentifier )
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CancelResizeApi->cancelResize: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier *
String
The unique identifier for the cluster that you want to cancel a resize operation for.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CopyClusterSnapshot

copyClusterSnapshot

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.


/CopyClusterSnapshot

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CopyClusterSnapshot?SourceSnapshotIdentifier=&TargetSnapshotIdentifier=&ManualSnapshotRetentionPeriod=&SourceSnapshotClusterIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CopyClusterSnapshotApi;

import java.io.File;
import java.util.*;

public class CopyClusterSnapshotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CopyClusterSnapshotApi apiInstance = new CopyClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String sourceSnapshotIdentifier = sourceSnapshotIdentifier_example; // String | The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

        String targetSnapshotIdentifier = targetSnapshotIdentifier_example; // String | The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
        Integer manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

        String sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example; // String | The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.           
        try {
            inline_response_200_6 result = apiInstance.copyClusterSnapshot(apiecoKey, sourceSnapshotIdentifier, targetSnapshotIdentifier, manualSnapshotRetentionPeriod, sourceSnapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CopyClusterSnapshotApi#copyClusterSnapshot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CopyClusterSnapshotApi;

public class CopyClusterSnapshotApiExample {

    public static void main(String[] args) {
        CopyClusterSnapshotApi apiInstance = new CopyClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String sourceSnapshotIdentifier = sourceSnapshotIdentifier_example; // String | The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

        String targetSnapshotIdentifier = targetSnapshotIdentifier_example; // String | The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
        Integer manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

        String sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example; // String | The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.           
        try {
            inline_response_200_6 result = apiInstance.copyClusterSnapshot(apiecoKey, sourceSnapshotIdentifier, targetSnapshotIdentifier, manualSnapshotRetentionPeriod, sourceSnapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CopyClusterSnapshotApi#copyClusterSnapshot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *sourceSnapshotIdentifier = sourceSnapshotIdentifier_example; // The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

String *targetSnapshotIdentifier = targetSnapshotIdentifier_example; // The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
Integer *manualSnapshotRetentionPeriod = 56; // The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
 (optional)
String *sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example; // The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.            (optional)

CopyClusterSnapshotApi *apiInstance = [[CopyClusterSnapshotApi alloc] init];

[apiInstance copyClusterSnapshotWith:apiecoKey
    sourceSnapshotIdentifier:sourceSnapshotIdentifier
    targetSnapshotIdentifier:targetSnapshotIdentifier
    manualSnapshotRetentionPeriod:manualSnapshotRetentionPeriod
    sourceSnapshotClusterIdentifier:sourceSnapshotClusterIdentifier
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CopyClusterSnapshotApi()

var apiecoKey = apiecoKey_example; // {String} 

var sourceSnapshotIdentifier = sourceSnapshotIdentifier_example; // {String} The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.


var targetSnapshotIdentifier = targetSnapshotIdentifier_example; // {String} The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.

var opts = { 
  'manualSnapshotRetentionPeriod': 56, // {Integer} The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

  'sourceSnapshotClusterIdentifier': sourceSnapshotClusterIdentifier_example // {String} The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.           
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyClusterSnapshot(apiecoKey, sourceSnapshotIdentifier, targetSnapshotIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class copyClusterSnapshotExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CopyClusterSnapshotApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var sourceSnapshotIdentifier = sourceSnapshotIdentifier_example;  // String | The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

            var targetSnapshotIdentifier = targetSnapshotIdentifier_example;  // String | The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
            var manualSnapshotRetentionPeriod = 56;  // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
 (optional) 
            var sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example;  // String | The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.            (optional) 

            try
            {
                inline_response_200_6 result = apiInstance.copyClusterSnapshot(apiecoKey, sourceSnapshotIdentifier, targetSnapshotIdentifier, manualSnapshotRetentionPeriod, sourceSnapshotClusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CopyClusterSnapshotApi.copyClusterSnapshot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CopyClusterSnapshotApi();
$apiecoKey = apiecoKey_example; // String | 
$sourceSnapshotIdentifier = sourceSnapshotIdentifier_example; // String | The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

$targetSnapshotIdentifier = targetSnapshotIdentifier_example; // String | The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
$manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

$sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example; // String | The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.           

try {
    $result = $api_instance->copyClusterSnapshot($apiecoKey, $sourceSnapshotIdentifier, $targetSnapshotIdentifier, $manualSnapshotRetentionPeriod, $sourceSnapshotClusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CopyClusterSnapshotApi->copyClusterSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CopyClusterSnapshotApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CopyClusterSnapshotApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $sourceSnapshotIdentifier = sourceSnapshotIdentifier_example; # String | The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

my $targetSnapshotIdentifier = targetSnapshotIdentifier_example; # String | The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
my $manualSnapshotRetentionPeriod = 56; # Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

my $sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example; # String | The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.           

eval { 
    my $result = $api_instance->copyClusterSnapshot(apiecoKey => $apiecoKey, sourceSnapshotIdentifier => $sourceSnapshotIdentifier, targetSnapshotIdentifier => $targetSnapshotIdentifier, manualSnapshotRetentionPeriod => $manualSnapshotRetentionPeriod, sourceSnapshotClusterIdentifier => $sourceSnapshotClusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CopyClusterSnapshotApi->copyClusterSnapshot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CopyClusterSnapshotApi()
apiecoKey = apiecoKey_example # String | 
sourceSnapshotIdentifier = sourceSnapshotIdentifier_example # String | The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.

targetSnapshotIdentifier = targetSnapshotIdentifier_example # String | The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
manualSnapshotRetentionPeriod = 56 # Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
 (optional)
sourceSnapshotClusterIdentifier = sourceSnapshotClusterIdentifier_example # String | The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
Must be the identifier for a valid cluster.            (optional)

try: 
    api_response = api_instance.copy_cluster_snapshot(apiecoKey, sourceSnapshotIdentifier, targetSnapshotIdentifier, manualSnapshotRetentionPeriod=manualSnapshotRetentionPeriod, sourceSnapshotClusterIdentifier=sourceSnapshotClusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CopyClusterSnapshotApi->copyClusterSnapshot: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SourceSnapshotIdentifier*
String
The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is available.
Required
TargetSnapshotIdentifier*
String
The identifier given to the new manual snapshot. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for the AWS account that is making the request.
Required
ManualSnapshotRetentionPeriod
Integer
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
SourceSnapshotClusterIdentifier
String
The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the identifier for a valid cluster.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateCluster

createCluster

Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.


/CreateCluster

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateCluster?ClusterIdentifier=&MasterUsername=&MasterUserPassword=&NodeType=&AdditionalInfo=&AllowVersionUpgrade=&AutomatedSnapshotRetentionPeriod=&AvailabilityZone=&ClusterParameterGroupName=&ClusterSubnetGroupName=&ClusterType=&ClusterVersion=&DBName=&ElasticIp=&Encrypted=&EnhancedVpcRouting=&HsmClientCertificateIdentifier=&HsmConfigurationIdentifier=&IamRoles.IamRoleArn.N=&KmsKeyId=&Port="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateClusterApi;

import java.io.File;
import java.util.*;

public class CreateClusterApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateClusterApi apiInstance = new CreateClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

        String masterUsername = masterUsername_example; // String | The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
        String masterUserPassword = masterUserPassword_example; // String | The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

        String nodeType = nodeType_example; // String | The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
        String additionalInfo = additionalInfo_example; // String | Reserved
        Boolean allowVersionUpgrade = true; // Boolean | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true
        Integer automatedSnapshotRetentionPeriod = 56; // Integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.              
        String availabilityZone = availabilityZone_example; // String | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
        String clusterParameterGroupName = clusterParameterGroupName_example; // String | The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.          
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).         
        String clusterType = clusterType_example; // String | The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
        String clusterVersion = clusterVersion_example; // String | The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
        String dBName = dBName_example; // String | The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev            
        String elasticIp = elasticIp_example; // String | The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.          
        Boolean encrypted = true; // Boolean | If true, the data in the cluster is encrypted at rest.
Default: false
        Boolean enhancedVpcRouting = true; // Boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
        array[String] iamRoles.IamRoleArn.N = ; // array[String] | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
        String kmsKeyId = kmsKeyId_example; // String | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
        BigDecimal port = 8.14; // BigDecimal | The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
        try {
            inline_response_200_7 result = apiInstance.createCluster(apiecoKey, clusterIdentifier, masterUsername, masterUserPassword, nodeType, additionalInfo, allowVersionUpgrade, automatedSnapshotRetentionPeriod, availabilityZone, clusterParameterGroupName, clusterSubnetGroupName, clusterType, clusterVersion, dBName, elasticIp, encrypted, enhancedVpcRouting, hsmClientCertificateIdentifier, hsmConfigurationIdentifier, iamRoles.IamRoleArn.N, kmsKeyId, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterApi#createCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateClusterApi;

public class CreateClusterApiExample {

    public static void main(String[] args) {
        CreateClusterApi apiInstance = new CreateClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

        String masterUsername = masterUsername_example; // String | The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
        String masterUserPassword = masterUserPassword_example; // String | The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

        String nodeType = nodeType_example; // String | The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
        String additionalInfo = additionalInfo_example; // String | Reserved
        Boolean allowVersionUpgrade = true; // Boolean | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true
        Integer automatedSnapshotRetentionPeriod = 56; // Integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.              
        String availabilityZone = availabilityZone_example; // String | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
        String clusterParameterGroupName = clusterParameterGroupName_example; // String | The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.          
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).         
        String clusterType = clusterType_example; // String | The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
        String clusterVersion = clusterVersion_example; // String | The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
        String dBName = dBName_example; // String | The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev            
        String elasticIp = elasticIp_example; // String | The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.          
        Boolean encrypted = true; // Boolean | If true, the data in the cluster is encrypted at rest.
Default: false
        Boolean enhancedVpcRouting = true; // Boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
        array[String] iamRoles.IamRoleArn.N = ; // array[String] | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
        String kmsKeyId = kmsKeyId_example; // String | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
        BigDecimal port = 8.14; // BigDecimal | The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
        try {
            inline_response_200_7 result = apiInstance.createCluster(apiecoKey, clusterIdentifier, masterUsername, masterUserPassword, nodeType, additionalInfo, allowVersionUpgrade, automatedSnapshotRetentionPeriod, availabilityZone, clusterParameterGroupName, clusterSubnetGroupName, clusterType, clusterVersion, dBName, elasticIp, encrypted, enhancedVpcRouting, hsmClientCertificateIdentifier, hsmConfigurationIdentifier, iamRoles.IamRoleArn.N, kmsKeyId, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterApi#createCluster");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterIdentifier = clusterIdentifier_example; // A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

String *masterUsername = masterUsername_example; // The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
String *masterUserPassword = masterUserPassword_example; // The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

String *nodeType = nodeType_example; // The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
String *additionalInfo = additionalInfo_example; // Reserved (optional)
Boolean *allowVersionUpgrade = true; // If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true (optional)
Integer *automatedSnapshotRetentionPeriod = 56; // The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.               (optional)
String *availabilityZone = availabilityZone_example; // The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint. (optional)
String *clusterParameterGroupName = clusterParameterGroupName_example; // The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.           (optional)
String *clusterSubnetGroupName = clusterSubnetGroupName_example; // The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).          (optional)
String *clusterType = clusterType_example; // The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node (optional)
String *clusterVersion = clusterVersion_example; // The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0 (optional)
String *dBName = dBName_example; // The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev             (optional)
String *elasticIp = elasticIp_example; // The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.           (optional)
Boolean *encrypted = true; // If true, the data in the cluster is encrypted at rest.
Default: false (optional)
Boolean *enhancedVpcRouting = true; // An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false (optional)
String *hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. (optional)
String *hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. (optional)
array[String] *iamRoles.IamRoleArn.N = ; // A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time. (optional)
String *kmsKeyId = kmsKeyId_example; // The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. (optional)
BigDecimal *port = 8.14; // The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535 (optional)

CreateClusterApi *apiInstance = [[CreateClusterApi alloc] init];

[apiInstance createClusterWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    masterUsername:masterUsername
    masterUserPassword:masterUserPassword
    nodeType:nodeType
    additionalInfo:additionalInfo
    allowVersionUpgrade:allowVersionUpgrade
    automatedSnapshotRetentionPeriod:automatedSnapshotRetentionPeriod
    availabilityZone:availabilityZone
    clusterParameterGroupName:clusterParameterGroupName
    clusterSubnetGroupName:clusterSubnetGroupName
    clusterType:clusterType
    clusterVersion:clusterVersion
    dBName:dBName
    elasticIp:elasticIp
    encrypted:encrypted
    enhancedVpcRouting:enhancedVpcRouting
    hsmClientCertificateIdentifier:hsmClientCertificateIdentifier
    hsmConfigurationIdentifier:hsmConfigurationIdentifier
    iamRoles.IamRoleArn.N:iamRoles.IamRoleArn.N
    kmsKeyId:kmsKeyId
    port:port
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateClusterApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           


var masterUsername = masterUsername_example; // {String} The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.

var masterUserPassword = masterUserPassword_example; // {String} The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.


var nodeType = nodeType_example; // {String} The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

var opts = { 
  'additionalInfo': additionalInfo_example, // {String} Reserved
  'allowVersionUpgrade': true, // {Boolean} If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true
  'automatedSnapshotRetentionPeriod': 56, // {Integer} The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.              
  'availabilityZone': availabilityZone_example, // {String} The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
  'clusterParameterGroupName': clusterParameterGroupName_example, // {String} The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.          
  'clusterSubnetGroupName': clusterSubnetGroupName_example, // {String} The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).         
  'clusterType': clusterType_example, // {String} The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
  'clusterVersion': clusterVersion_example, // {String} The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
  'dBName': dBName_example, // {String} The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev            
  'elasticIp': elasticIp_example, // {String} The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.          
  'encrypted': true, // {Boolean} If true, the data in the cluster is encrypted at rest.
Default: false
  'enhancedVpcRouting': true, // {Boolean} An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
  'hsmClientCertificateIdentifier': hsmClientCertificateIdentifier_example, // {String} Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
  'hsmConfigurationIdentifier': hsmConfigurationIdentifier_example, // {String} Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
  'iamRoles.IamRoleArn.N': , // {array[String]} A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
  'kmsKeyId': kmsKeyId_example, // {String} The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
  'port': 8.14 // {BigDecimal} The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCluster(apiecoKey, clusterIdentifier, masterUsername, masterUserPassword, nodeType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createClusterExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateClusterApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

            var masterUsername = masterUsername_example;  // String | The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
            var masterUserPassword = masterUserPassword_example;  // String | The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

            var nodeType = nodeType_example;  // String | The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
            var additionalInfo = additionalInfo_example;  // String | Reserved (optional) 
            var allowVersionUpgrade = true;  // Boolean | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true (optional) 
            var automatedSnapshotRetentionPeriod = 56;  // Integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.               (optional) 
            var availabilityZone = availabilityZone_example;  // String | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint. (optional) 
            var clusterParameterGroupName = clusterParameterGroupName_example;  // String | The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.           (optional) 
            var clusterSubnetGroupName = clusterSubnetGroupName_example;  // String | The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).          (optional) 
            var clusterType = clusterType_example;  // String | The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node (optional) 
            var clusterVersion = clusterVersion_example;  // String | The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0 (optional) 
            var dBName = dBName_example;  // String | The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev             (optional) 
            var elasticIp = elasticIp_example;  // String | The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.           (optional) 
            var encrypted = true;  // Boolean | If true, the data in the cluster is encrypted at rest.
Default: false (optional) 
            var enhancedVpcRouting = true;  // Boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false (optional) 
            var hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example;  // String | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. (optional) 
            var hsmConfigurationIdentifier = hsmConfigurationIdentifier_example;  // String | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. (optional) 
            var iamRoles.IamRoleArn.N = new array[String](); // array[String] | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time. (optional) 
            var kmsKeyId = kmsKeyId_example;  // String | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. (optional) 
            var port = 8.14;  // BigDecimal | The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535 (optional) 

            try
            {
                inline_response_200_7 result = apiInstance.createCluster(apiecoKey, clusterIdentifier, masterUsername, masterUserPassword, nodeType, additionalInfo, allowVersionUpgrade, automatedSnapshotRetentionPeriod, availabilityZone, clusterParameterGroupName, clusterSubnetGroupName, clusterType, clusterVersion, dBName, elasticIp, encrypted, enhancedVpcRouting, hsmClientCertificateIdentifier, hsmConfigurationIdentifier, iamRoles.IamRoleArn.N, kmsKeyId, port);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateClusterApi.createCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateClusterApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

$masterUsername = masterUsername_example; // String | The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
$masterUserPassword = masterUserPassword_example; // String | The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

$nodeType = nodeType_example; // String | The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
$additionalInfo = additionalInfo_example; // String | Reserved
$allowVersionUpgrade = true; // Boolean | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true
$automatedSnapshotRetentionPeriod = 56; // Integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.              
$availabilityZone = availabilityZone_example; // String | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
$clusterParameterGroupName = clusterParameterGroupName_example; // String | The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.          
$clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).         
$clusterType = clusterType_example; // String | The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
$clusterVersion = clusterVersion_example; // String | The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
$dBName = dBName_example; // String | The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev            
$elasticIp = elasticIp_example; // String | The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.          
$encrypted = true; // Boolean | If true, the data in the cluster is encrypted at rest.
Default: false
$enhancedVpcRouting = true; // Boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
$hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
$hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
$iamRoles.IamRoleArn.N = ; // array[String] | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
$kmsKeyId = kmsKeyId_example; // String | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
$port = 8.14; // BigDecimal | The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535

try {
    $result = $api_instance->createCluster($apiecoKey, $clusterIdentifier, $masterUsername, $masterUserPassword, $nodeType, $additionalInfo, $allowVersionUpgrade, $automatedSnapshotRetentionPeriod, $availabilityZone, $clusterParameterGroupName, $clusterSubnetGroupName, $clusterType, $clusterVersion, $dBName, $elasticIp, $encrypted, $enhancedVpcRouting, $hsmClientCertificateIdentifier, $hsmConfigurationIdentifier, $iamRoles.IamRoleArn.N, $kmsKeyId, $port);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateClusterApi->createCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateClusterApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateClusterApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

my $masterUsername = masterUsername_example; # String | The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
my $masterUserPassword = masterUserPassword_example; # String | The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

my $nodeType = nodeType_example; # String | The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
my $additionalInfo = additionalInfo_example; # String | Reserved
my $allowVersionUpgrade = true; # Boolean | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true
my $automatedSnapshotRetentionPeriod = 56; # Integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.              
my $availabilityZone = availabilityZone_example; # String | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
my $clusterParameterGroupName = clusterParameterGroupName_example; # String | The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.          
my $clusterSubnetGroupName = clusterSubnetGroupName_example; # String | The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).         
my $clusterType = clusterType_example; # String | The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
my $clusterVersion = clusterVersion_example; # String | The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
my $dBName = dBName_example; # String | The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev            
my $elasticIp = elasticIp_example; # String | The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.          
my $encrypted = true; # Boolean | If true, the data in the cluster is encrypted at rest.
Default: false
my $enhancedVpcRouting = true; # Boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
my $hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; # String | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
my $hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; # String | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
my $iamRoles.IamRoleArn.N = []; # array[String] | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
my $kmsKeyId = kmsKeyId_example; # String | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
my $port = 8.14; # BigDecimal | The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535

eval { 
    my $result = $api_instance->createCluster(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, masterUsername => $masterUsername, masterUserPassword => $masterUserPassword, nodeType => $nodeType, additionalInfo => $additionalInfo, allowVersionUpgrade => $allowVersionUpgrade, automatedSnapshotRetentionPeriod => $automatedSnapshotRetentionPeriod, availabilityZone => $availabilityZone, clusterParameterGroupName => $clusterParameterGroupName, clusterSubnetGroupName => $clusterSubnetGroupName, clusterType => $clusterType, clusterVersion => $clusterVersion, dBName => $dBName, elasticIp => $elasticIp, encrypted => $encrypted, enhancedVpcRouting => $enhancedVpcRouting, hsmClientCertificateIdentifier => $hsmClientCertificateIdentifier, hsmConfigurationIdentifier => $hsmConfigurationIdentifier, iamRoles.IamRoleArn.N => $iamRoles.IamRoleArn.N, kmsKeyId => $kmsKeyId, port => $port);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateClusterApi->createCluster: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateClusterApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster           

masterUsername = masterUsername_example # String | The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved            Words in the Amazon Redshift Database Developer Guide.
masterUserPassword = masterUserPassword_example # String | The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except  (singl quote),  (double quote), \, /, @, or space.

nodeType = nodeType_example # String | The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |      dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
additionalInfo = additionalInfo_example # String | Reserved (optional)
allowVersionUpgrade = true # Boolean | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can                 request that the service automatically apply upgrades during the maintenance                 window to the Amazon Redshift engine that is running on your cluster.
Default: true (optional)
automatedSnapshotRetentionPeriod = 56 # Integer | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.               (optional)
availabilityZone = availabilityZone_example # String | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint. (optional)
clusterParameterGroupName = clusterParameterGroupName_example # String | The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.           (optional)
clusterSubnetGroupName = clusterSubnetGroupName_example # String | The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed        outside virtual private cloud (VPC).          (optional)
clusterType = clusterType_example # String | The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node (optional)
clusterVersion = clusterVersion_example # String | The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0 (optional)
dBName = dBName_example # String | The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the            cluster with a SQL client and use SQL commands to create a database. For            more information, go to Create a Database in the Amazon Redshift Database            Developer Guide.
Default: dev             (optional)
elasticIp = elasticIp_example # String | The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly            -accessible through an Internet gateway. For more information about              provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your          Cluster in the Amazon Redshift Cluster Management Guide.           (optional)
encrypted = true # Boolean | If true, the data in the cluster is encrypted at rest.
Default: false (optional)
enhancedVpcRouting = true # Boolean | An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false (optional)
hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example # String | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. (optional)
hsmConfigurationIdentifier = hsmConfigurationIdentifier_example # String | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. (optional)
iamRoles.IamRoleArn.N =  # array[String] | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time. (optional)
kmsKeyId = kmsKeyId_example # String | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. (optional)
port = 8.14 # BigDecimal | The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part             of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535 (optional)

try: 
    api_response = api_instance.create_cluster(apiecoKey, clusterIdentifier, masterUsername, masterUserPassword, nodeType, additionalInfo=additionalInfo, allowVersionUpgrade=allowVersionUpgrade, automatedSnapshotRetentionPeriod=automatedSnapshotRetentionPeriod, availabilityZone=availabilityZone, clusterParameterGroupName=clusterParameterGroupName, clusterSubnetGroupName=clusterSubnetGroupName, clusterType=clusterType, clusterVersion=clusterVersion, dBName=dBName, elasticIp=elasticIp, encrypted=encrypted, enhancedVpcRouting=enhancedVpcRouting, hsmClientCertificateIdentifier=hsmClientCertificateIdentifier, hsmConfigurationIdentifier=hsmConfigurationIdentifier, iamRoles.IamRoleArn.N=iamRoles.IamRoleArn.N, kmsKeyId=kmsKeyId, port=port)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateClusterApi->createCluster: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: myexamplecluster
Required
MasterUsername*
String
The user name associated with the master user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters. The user name can`t be PUBLIC. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Required
MasterUserPassword*
String
The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except (singl quote), (double quote), \, /, @, or space.
Required
NodeType*
String
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
Required
AdditionalInfo
String
Reserved
AllowVersionUpgrade
Boolean
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
AutomatedSnapshotRetentionPeriod
Integer
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: 1 Constraints: Must be a value from 0 to 35.
AvailabilityZone
String
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint.
ClusterParameterGroupName
String
The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
ClusterSubnetGroupName
String
The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
ClusterType
String
The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
ClusterVersion
String
The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: 1.0
DBName
String
The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev
ElasticIp
String
The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly -accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Encrypted
Boolean
If true, the data in the cluster is encrypted at rest. Default: false
EnhancedVpcRouting
Boolean
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
HsmClientCertificateIdentifier
String
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier
String
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
IamRoles.IamRoleArn.N
array[String]
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time.
KmsKeyId
String
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
Port
BigDecimal
The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: 1150-65535

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateClusterParameterGroup

createClusterParameterGroup

Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.


/CreateClusterParameterGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateClusterParameterGroup?Description =&ParameterGroupFamily=&ParameterGroupName=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateClusterParameterGroupApi;

import java.io.File;
import java.util.*;

public class CreateClusterParameterGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateClusterParameterGroupApi apiInstance = new CreateClusterParameterGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String description  = description _example; // String | TA description of the parameter group.

        String parameterGroupFamily = parameterGroupFamily_example; // String | TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
        String parameterGroupName = parameterGroupName_example; // String | The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

        array[String] tags.Tag.N = ; // array[String] | TA list of tag instances.
        try {
            inline_response_200_8 result = apiInstance.createClusterParameterGroup(apiecoKey, description , parameterGroupFamily, parameterGroupName, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterParameterGroupApi#createClusterParameterGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateClusterParameterGroupApi;

public class CreateClusterParameterGroupApiExample {

    public static void main(String[] args) {
        CreateClusterParameterGroupApi apiInstance = new CreateClusterParameterGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String description  = description _example; // String | TA description of the parameter group.

        String parameterGroupFamily = parameterGroupFamily_example; // String | TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
        String parameterGroupName = parameterGroupName_example; // String | The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

        array[String] tags.Tag.N = ; // array[String] | TA list of tag instances.
        try {
            inline_response_200_8 result = apiInstance.createClusterParameterGroup(apiecoKey, description , parameterGroupFamily, parameterGroupName, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterParameterGroupApi#createClusterParameterGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *description  = description _example; // TA description of the parameter group.

String *parameterGroupFamily = parameterGroupFamily_example; // TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
String *parameterGroupName = parameterGroupName_example; // The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

array[String] *tags.Tag.N = ; // TA list of tag instances. (optional)

CreateClusterParameterGroupApi *apiInstance = [[CreateClusterParameterGroupApi alloc] init];

[apiInstance createClusterParameterGroupWith:apiecoKey
    description :description 
    parameterGroupFamily:parameterGroupFamily
    parameterGroupName:parameterGroupName
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateClusterParameterGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var description  = description _example; // {String} TA description of the parameter group.


var parameterGroupFamily = parameterGroupFamily_example; // {String} TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".

var parameterGroupName = parameterGroupName_example; // {String} The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.


var opts = { 
  'tags.Tag.N':  // {array[String]} TA list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createClusterParameterGroup(apiecoKey, description , parameterGroupFamily, parameterGroupName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createClusterParameterGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateClusterParameterGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var description  = description _example;  // String | TA description of the parameter group.

            var parameterGroupFamily = parameterGroupFamily_example;  // String | TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
            var parameterGroupName = parameterGroupName_example;  // String | The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

            var tags.Tag.N = new array[String](); // array[String] | TA list of tag instances. (optional) 

            try
            {
                inline_response_200_8 result = apiInstance.createClusterParameterGroup(apiecoKey, description , parameterGroupFamily, parameterGroupName, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateClusterParameterGroupApi.createClusterParameterGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateClusterParameterGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$description  = description _example; // String | TA description of the parameter group.

$parameterGroupFamily = parameterGroupFamily_example; // String | TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
$parameterGroupName = parameterGroupName_example; // String | The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

$tags.Tag.N = ; // array[String] | TA list of tag instances.

try {
    $result = $api_instance->createClusterParameterGroup($apiecoKey, $description , $parameterGroupFamily, $parameterGroupName, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateClusterParameterGroupApi->createClusterParameterGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateClusterParameterGroupApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateClusterParameterGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $description  = description _example; # String | TA description of the parameter group.

my $parameterGroupFamily = parameterGroupFamily_example; # String | TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
my $parameterGroupName = parameterGroupName_example; # String | The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

my $tags.Tag.N = []; # array[String] | TA list of tag instances.

eval { 
    my $result = $api_instance->createClusterParameterGroup(apiecoKey => $apiecoKey, description  => $description , parameterGroupFamily => $parameterGroupFamily, parameterGroupName => $parameterGroupName, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateClusterParameterGroupApi->createClusterParameterGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateClusterParameterGroupApi()
apiecoKey = apiecoKey_example # String | 
description  = description _example # String | TA description of the parameter group.

parameterGroupFamily = parameterGroupFamily_example # String | TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call          DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including          the default parameter groups for each Amazon Redshift engine version. The        parameter group family names associated with the default parameter groups          provide you the valid values. For example, a valid family name is "redshift         -1.0".
parameterGroupName = parameterGroupName_example # String | The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
Note This value is stored as a lower-case string.

tags.Tag.N =  # array[String] | TA list of tag instances. (optional)

try: 
    api_response = api_instance.create_cluster_parameter_group(apiecoKey, description , parameterGroupFamily, parameterGroupName, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateClusterParameterGroupApi->createClusterParameterGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
Description *
String
TA description of the parameter group.
Required
ParameterGroupFamily*
String
TThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift -1.0".
Required
ParameterGroupName*
String
The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. Note This value is stored as a lower-case string.
Required
Tags.Tag.N
array[String]
TA list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateClusterSecurityGroup

createClusterSecurityGroup

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.


/CreateClusterSecurityGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateClusterSecurityGroup?ClusterSecurityGroupName=&Description=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateClusterSecurityGroupApi;

import java.io.File;
import java.util.*;

public class CreateClusterSecurityGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateClusterSecurityGroupApi apiInstance = new CreateClusterSecurityGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

        String description = description_example; // String | A description for the security group.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.

        try {
            inline_response_200_9 result = apiInstance.createClusterSecurityGroup(apiecoKey, clusterSecurityGroupName, description, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterSecurityGroupApi#createClusterSecurityGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateClusterSecurityGroupApi;

public class CreateClusterSecurityGroupApiExample {

    public static void main(String[] args) {
        CreateClusterSecurityGroupApi apiInstance = new CreateClusterSecurityGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

        String description = description_example; // String | A description for the security group.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.

        try {
            inline_response_200_9 result = apiInstance.createClusterSecurityGroup(apiecoKey, clusterSecurityGroupName, description, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterSecurityGroupApi#createClusterSecurityGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterSecurityGroupName = clusterSecurityGroupName_example; // The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

String *description = description_example; // A description for the security group.
array[String] *tags.Tag.N = ; // A list of tag instances.
 (optional)

CreateClusterSecurityGroupApi *apiInstance = [[CreateClusterSecurityGroupApi alloc] init];

[apiInstance createClusterSecurityGroupWith:apiecoKey
    clusterSecurityGroupName:clusterSecurityGroupName
    description:description
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateClusterSecurityGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterSecurityGroupName = clusterSecurityGroupName_example; // {String} The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup


var description = description_example; // {String} A description for the security group.

var opts = { 
  'tags.Tag.N':  // {array[String]} A list of tag instances.

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createClusterSecurityGroup(apiecoKey, clusterSecurityGroupName, description, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createClusterSecurityGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateClusterSecurityGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSecurityGroupName = clusterSecurityGroupName_example;  // String | The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

            var description = description_example;  // String | A description for the security group.
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances.
 (optional) 

            try
            {
                inline_response_200_9 result = apiInstance.createClusterSecurityGroup(apiecoKey, clusterSecurityGroupName, description, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateClusterSecurityGroupApi.createClusterSecurityGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateClusterSecurityGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

$description = description_example; // String | A description for the security group.
$tags.Tag.N = ; // array[String] | A list of tag instances.


try {
    $result = $api_instance->createClusterSecurityGroup($apiecoKey, $clusterSecurityGroupName, $description, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateClusterSecurityGroupApi->createClusterSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateClusterSecurityGroupApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateClusterSecurityGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSecurityGroupName = clusterSecurityGroupName_example; # String | The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

my $description = description_example; # String | A description for the security group.
my $tags.Tag.N = []; # array[String] | A list of tag instances.


eval { 
    my $result = $api_instance->createClusterSecurityGroup(apiecoKey => $apiecoKey, clusterSecurityGroupName => $clusterSecurityGroupName, description => $description, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateClusterSecurityGroupApi->createClusterSecurityGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateClusterSecurityGroupApi()
apiecoKey = apiecoKey_example # String | 
clusterSecurityGroupName = clusterSecurityGroupName_example # String | The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup

description = description_example # String | A description for the security group.
tags.Tag.N =  # array[String] | A list of tag instances.
 (optional)

try: 
    api_response = api_instance.create_cluster_security_group(apiecoKey, clusterSecurityGroupName, description, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateClusterSecurityGroupApi->createClusterSecurityGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSecurityGroupName*
String
The name for the security group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all security groups that are created by your AWS account. Example: examplesecuritygroup
Required
Description*
String
A description for the security group.
Required
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateClusterSnapshot

createClusterSnapshot

Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.


/CreateClusterSnapshot

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateClusterSnapshot?ClusterIdentifier=&SnapshotIdentifier=&ManualSnapshotRetentionPeriod=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateClusterSnapshotApi;

import java.io.File;
import java.util.*;

public class CreateClusterSnapshotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateClusterSnapshotApi apiInstance = new CreateClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The cluster identifier for which you want a snapshot.



        String snapshotIdentifier = snapshotIdentifier_example; // String | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
        Integer manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_6_snapshot result = apiInstance.createClusterSnapshot(apiecoKey, clusterIdentifier, snapshotIdentifier, manualSnapshotRetentionPeriod, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterSnapshotApi#createClusterSnapshot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateClusterSnapshotApi;

public class CreateClusterSnapshotApiExample {

    public static void main(String[] args) {
        CreateClusterSnapshotApi apiInstance = new CreateClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The cluster identifier for which you want a snapshot.



        String snapshotIdentifier = snapshotIdentifier_example; // String | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
        Integer manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_6_snapshot result = apiInstance.createClusterSnapshot(apiecoKey, clusterIdentifier, snapshotIdentifier, manualSnapshotRetentionPeriod, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterSnapshotApi#createClusterSnapshot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterIdentifier = clusterIdentifier_example; // The cluster identifier for which you want a snapshot.



String *snapshotIdentifier = snapshotIdentifier_example; // A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Integer *manualSnapshotRetentionPeriod = 56; // The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
 (optional)
array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateClusterSnapshotApi *apiInstance = [[CreateClusterSnapshotApi alloc] init];

[apiInstance createClusterSnapshotWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    snapshotIdentifier:snapshotIdentifier
    manualSnapshotRetentionPeriod:manualSnapshotRetentionPeriod
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_6_snapshot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateClusterSnapshotApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The cluster identifier for which you want a snapshot.




var snapshotIdentifier = snapshotIdentifier_example; // {String} A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id

var opts = { 
  'manualSnapshotRetentionPeriod': 56, // {Integer} The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createClusterSnapshot(apiecoKey, clusterIdentifier, snapshotIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createClusterSnapshotExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateClusterSnapshotApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The cluster identifier for which you want a snapshot.



            var snapshotIdentifier = snapshotIdentifier_example;  // String | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
            var manualSnapshotRetentionPeriod = 56;  // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
 (optional) 
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_6_snapshot result = apiInstance.createClusterSnapshot(apiecoKey, clusterIdentifier, snapshotIdentifier, manualSnapshotRetentionPeriod, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateClusterSnapshotApi.createClusterSnapshot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateClusterSnapshotApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The cluster identifier for which you want a snapshot.



$snapshotIdentifier = snapshotIdentifier_example; // String | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
$manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createClusterSnapshot($apiecoKey, $clusterIdentifier, $snapshotIdentifier, $manualSnapshotRetentionPeriod, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateClusterSnapshotApi->createClusterSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateClusterSnapshotApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateClusterSnapshotApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The cluster identifier for which you want a snapshot.



my $snapshotIdentifier = snapshotIdentifier_example; # String | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
my $manualSnapshotRetentionPeriod = 56; # Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.

my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createClusterSnapshot(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, snapshotIdentifier => $snapshotIdentifier, manualSnapshotRetentionPeriod => $manualSnapshotRetentionPeriod, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateClusterSnapshotApi->createClusterSnapshot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateClusterSnapshotApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The cluster identifier for which you want a snapshot.



snapshotIdentifier = snapshotIdentifier_example # String | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
manualSnapshotRetentionPeriod = 56 # Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
 (optional)
tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_cluster_snapshot(apiecoKey, clusterIdentifier, snapshotIdentifier, manualSnapshotRetentionPeriod=manualSnapshotRetentionPeriod, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateClusterSnapshotApi->createClusterSnapshot: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The cluster identifier for which you want a snapshot.
Required
SnapshotIdentifier*
String
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
Required
ManualSnapshotRetentionPeriod
Integer
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateClusterSubnetGroup

createClusterSubnetGroup

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.


/CreateClusterSubnetGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateClusterSubnetGroup?ClusterSubnetGroupName=&Description=&SubnetIds.SubnetIdentifier.N=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateClusterSubnetGroupApi;

import java.io.File;
import java.util.*;

public class CreateClusterSubnetGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateClusterSubnetGroupApi apiInstance = new CreateClusterSubnetGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

        String description = description_example; // String | A description for the subnet group.
        array[String] subnetIds.SubnetIdentifier.N = ; // array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_10 result = apiInstance.createClusterSubnetGroup(apiecoKey, clusterSubnetGroupName, description, subnetIds.SubnetIdentifier.N, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterSubnetGroupApi#createClusterSubnetGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateClusterSubnetGroupApi;

public class CreateClusterSubnetGroupApiExample {

    public static void main(String[] args) {
        CreateClusterSubnetGroupApi apiInstance = new CreateClusterSubnetGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

        String description = description_example; // String | A description for the subnet group.
        array[String] subnetIds.SubnetIdentifier.N = ; // array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_10 result = apiInstance.createClusterSubnetGroup(apiecoKey, clusterSubnetGroupName, description, subnetIds.SubnetIdentifier.N, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateClusterSubnetGroupApi#createClusterSubnetGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterSubnetGroupName = clusterSubnetGroupName_example; // The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

String *description = description_example; // A description for the subnet group.
array[String] *subnetIds.SubnetIdentifier.N = ; // An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateClusterSubnetGroupApi *apiInstance = [[CreateClusterSubnetGroupApi alloc] init];

[apiInstance createClusterSubnetGroupWith:apiecoKey
    clusterSubnetGroupName:clusterSubnetGroupName
    description:description
    subnetIds.SubnetIdentifier.N:subnetIds.SubnetIdentifier.N
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_10 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateClusterSubnetGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterSubnetGroupName = clusterSubnetGroupName_example; // {String} The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             


var description = description_example; // {String} A description for the subnet group.

var subnetIds.SubnetIdentifier.N = ; // {array[String]} An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.


var opts = { 
  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createClusterSubnetGroup(apiecoKey, clusterSubnetGroupName, description, subnetIds.SubnetIdentifier.N, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createClusterSubnetGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateClusterSubnetGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSubnetGroupName = clusterSubnetGroupName_example;  // String | The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

            var description = description_example;  // String | A description for the subnet group.
            var subnetIds.SubnetIdentifier.N = new array[String](); // array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_10 result = apiInstance.createClusterSubnetGroup(apiecoKey, clusterSubnetGroupName, description, subnetIds.SubnetIdentifier.N, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateClusterSubnetGroupApi.createClusterSubnetGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateClusterSubnetGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

$description = description_example; // String | A description for the subnet group.
$subnetIds.SubnetIdentifier.N = ; // array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createClusterSubnetGroup($apiecoKey, $clusterSubnetGroupName, $description, $subnetIds.SubnetIdentifier.N, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateClusterSubnetGroupApi->createClusterSubnetGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateClusterSubnetGroupApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateClusterSubnetGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSubnetGroupName = clusterSubnetGroupName_example; # String | The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

my $description = description_example; # String | A description for the subnet group.
my $subnetIds.SubnetIdentifier.N = []; # array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createClusterSubnetGroup(apiecoKey => $apiecoKey, clusterSubnetGroupName => $clusterSubnetGroupName, description => $description, subnetIds.SubnetIdentifier.N => $subnetIds.SubnetIdentifier.N, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateClusterSubnetGroupApi->createClusterSubnetGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateClusterSubnetGroupApi()
apiecoKey = apiecoKey_example # String | 
clusterSubnetGroupName = clusterSubnetGroupName_example # String | The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup             

description = description_example # String | A description for the subnet group.
subnetIds.SubnetIdentifier.N =  # array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_cluster_subnet_group(apiecoKey, clusterSubnetGroupName, description, subnetIds.SubnetIdentifier.N, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateClusterSubnetGroupApi->createClusterSubnetGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSubnetGroupName*
String
The name for the subnet group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all subnet groups that are created by your AWS account. Example: examplesubnetgroup
Required
Description*
String
A description for the subnet group.
Required
SubnetIds.SubnetIdentifier.N*
array[String]
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
Required
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateEventSubscription

createEventSubscription

CCreates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.


/CreateEventSubscription

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateEventSubscription?SnsTopicArn=&SubscriptionName=&Enabled=&EventCategories.EventCategory.N=&SourceIds.SourceId.N=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateEventSubscriptionApi;

import java.io.File;
import java.util.*;

public class CreateEventSubscriptionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateEventSubscriptionApi apiInstance = new CreateEventSubscriptionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snsTopicArn = snsTopicArn_example; // String | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

        String subscriptionName = subscriptionName_example; // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        Boolean enabled = true; // Boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

        array[String] eventCategories.EventCategory.N = ; // array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security
        array[String] sourceIds.SourceId.N = ; // array[String] | A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_11 result = apiInstance.createEventSubscription(apiecoKey, snsTopicArn, subscriptionName, enabled, eventCategories.EventCategory.N, sourceIds.SourceId.N, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateEventSubscriptionApi#createEventSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateEventSubscriptionApi;

public class CreateEventSubscriptionApiExample {

    public static void main(String[] args) {
        CreateEventSubscriptionApi apiInstance = new CreateEventSubscriptionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snsTopicArn = snsTopicArn_example; // String | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

        String subscriptionName = subscriptionName_example; // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        Boolean enabled = true; // Boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

        array[String] eventCategories.EventCategory.N = ; // array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security
        array[String] sourceIds.SourceId.N = ; // array[String] | A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_11 result = apiInstance.createEventSubscription(apiecoKey, snsTopicArn, subscriptionName, enabled, eventCategories.EventCategory.N, sourceIds.SourceId.N, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateEventSubscriptionApi#createEventSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *snsTopicArn = snsTopicArn_example; // The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

String *subscriptionName = subscriptionName_example; // The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Boolean *enabled = true; // A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
 (optional)
array[String] *eventCategories.EventCategory.N = ; // Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security (optional)
array[String] *sourceIds.SourceId.N = ; // A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. (optional)
array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateEventSubscriptionApi *apiInstance = [[CreateEventSubscriptionApi alloc] init];

[apiInstance createEventSubscriptionWith:apiecoKey
    snsTopicArn:snsTopicArn
    subscriptionName:subscriptionName
    enabled:enabled
    eventCategories.EventCategory.N:eventCategories.EventCategory.N
    sourceIds.SourceId.N:sourceIds.SourceId.N
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_11 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateEventSubscriptionApi()

var apiecoKey = apiecoKey_example; // {String} 

var snsTopicArn = snsTopicArn_example; // {String} The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.


var subscriptionName = subscriptionName_example; // {String} The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

var opts = { 
  'enabled': true, // {Boolean} A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

  'eventCategories.EventCategory.N': , // {array[String]} Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security
  'sourceIds.SourceId.N': , // {array[String]} A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEventSubscription(apiecoKey, snsTopicArn, subscriptionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createEventSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateEventSubscriptionApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var snsTopicArn = snsTopicArn_example;  // String | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

            var subscriptionName = subscriptionName_example;  // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
            var enabled = true;  // Boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
 (optional) 
            var eventCategories.EventCategory.N = new array[String](); // array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security (optional) 
            var sourceIds.SourceId.N = new array[String](); // array[String] | A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. (optional) 
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_11 result = apiInstance.createEventSubscription(apiecoKey, snsTopicArn, subscriptionName, enabled, eventCategories.EventCategory.N, sourceIds.SourceId.N, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateEventSubscriptionApi.createEventSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateEventSubscriptionApi();
$apiecoKey = apiecoKey_example; // String | 
$snsTopicArn = snsTopicArn_example; // String | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

$subscriptionName = subscriptionName_example; // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
$enabled = true; // Boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

$eventCategories.EventCategory.N = ; // array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security
$sourceIds.SourceId.N = ; // array[String] | A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createEventSubscription($apiecoKey, $snsTopicArn, $subscriptionName, $enabled, $eventCategories.EventCategory.N, $sourceIds.SourceId.N, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateEventSubscriptionApi->createEventSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateEventSubscriptionApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateEventSubscriptionApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $snsTopicArn = snsTopicArn_example; # String | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

my $subscriptionName = subscriptionName_example; # String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
my $enabled = true; # Boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

my $eventCategories.EventCategory.N = []; # array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security
my $sourceIds.SourceId.N = []; # array[String] | A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createEventSubscription(apiecoKey => $apiecoKey, snsTopicArn => $snsTopicArn, subscriptionName => $subscriptionName, enabled => $enabled, eventCategories.EventCategory.N => $eventCategories.EventCategory.N, sourceIds.SourceId.N => $sourceIds.SourceId.N, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateEventSubscriptionApi->createEventSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateEventSubscriptionApi()
apiecoKey = apiecoKey_example # String | 
snsTopicArn = snsTopicArn_example # String | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

subscriptionName = subscriptionName_example # String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
enabled = true # Boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
 (optional)
eventCategories.EventCategory.N =  # array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security (optional)
sourceIds.SourceId.N =  # array[String] | A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. (optional)
tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_event_subscription(apiecoKey, snsTopicArn, subscriptionName, enabled=enabled, eventCategories.EventCategory.N=eventCategories.EventCategory.N, sourceIds.SourceId.N=sourceIds.SourceId.N, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateEventSubscriptionApi->createEventSubscription: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SnsTopicArn*
String
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
Required
SubscriptionName*
String
The name of the event subscription to be created. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
Required
Enabled
Boolean
A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
EventCategories.EventCategory.N
array[String]
Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security
SourceIds.SourceId.N
array[String]
A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateHsmClientCertificate

createHsmClientCertificate

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.


/CreateHsmClientCertificate

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateHsmClientCertificate?HsmClientCertificateIdentifier=&SubscriptionName=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateHsmClientCertificateApi;

import java.io.File;
import java.util.*;

public class CreateHsmClientCertificateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateHsmClientCertificateApi apiInstance = new CreateHsmClientCertificateApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

        String subscriptionName = subscriptionName_example; // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_12 result = apiInstance.createHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier, subscriptionName, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateHsmClientCertificateApi#createHsmClientCertificate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateHsmClientCertificateApi;

public class CreateHsmClientCertificateApiExample {

    public static void main(String[] args) {
        CreateHsmClientCertificateApi apiInstance = new CreateHsmClientCertificateApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

        String subscriptionName = subscriptionName_example; // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_12 result = apiInstance.createHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier, subscriptionName, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateHsmClientCertificateApi#createHsmClientCertificate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

String *subscriptionName = subscriptionName_example; // The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateHsmClientCertificateApi *apiInstance = [[CreateHsmClientCertificateApi alloc] init];

[apiInstance createHsmClientCertificateWith:apiecoKey
    hsmClientCertificateIdentifier:hsmClientCertificateIdentifier
    subscriptionName:subscriptionName
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateHsmClientCertificateApi()

var apiecoKey = apiecoKey_example; // {String} 

var hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // {String} The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.


var subscriptionName = subscriptionName_example; // {String} The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

var opts = { 
  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier, subscriptionName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createHsmClientCertificateExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateHsmClientCertificateApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example;  // String | The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

            var subscriptionName = subscriptionName_example;  // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_12 result = apiInstance.createHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier, subscriptionName, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateHsmClientCertificateApi.createHsmClientCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateHsmClientCertificateApi();
$apiecoKey = apiecoKey_example; // String | 
$hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

$subscriptionName = subscriptionName_example; // String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createHsmClientCertificate($apiecoKey, $hsmClientCertificateIdentifier, $subscriptionName, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateHsmClientCertificateApi->createHsmClientCertificate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateHsmClientCertificateApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateHsmClientCertificateApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; # String | The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

my $subscriptionName = subscriptionName_example; # String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createHsmClientCertificate(apiecoKey => $apiecoKey, hsmClientCertificateIdentifier => $hsmClientCertificateIdentifier, subscriptionName => $subscriptionName, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateHsmClientCertificateApi->createHsmClientCertificate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateHsmClientCertificateApi()
apiecoKey = apiecoKey_example # String | 
hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example # String | The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

subscriptionName = subscriptionName_example # String | The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_hsm_client_certificate(apiecoKey, hsmClientCertificateIdentifier, subscriptionName, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateHsmClientCertificateApi->createHsmClientCertificate: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
HsmClientCertificateIdentifier*
String
The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
Required
SubscriptionName*
String
The name of the event subscription to be created. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
Required
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateHsmConfiguration

createHsmConfiguration

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.


/CreateHsmConfiguration

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateHsmConfiguration?Description=&HsmConfigurationIdentifier=&HsmIpAddress=&HsmPartitionName=&HsmPartitionPassword=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateHsmConfigurationApi;

import java.io.File;
import java.util.*;

public class CreateHsmConfigurationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateHsmConfigurationApi apiInstance = new CreateHsmConfigurationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String description = description_example; // String | A text description of the HSM configuration to be created.
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | The identifier to be assigned to the new Amazon Redshift HSM configuration.
        String hsmIpAddress = hsmIpAddress_example; // String | The IP address that the Amazon Redshift cluster must use to access the HSM.
        String hsmPartitionName = hsmPartitionName_example; // String | The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
        String hsmPartitionPassword = hsmPartitionPassword_example; // String | The password required to access the HSM partition.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_13 result = apiInstance.createHsmConfiguration(apiecoKey, description, hsmConfigurationIdentifier, hsmIpAddress, hsmPartitionName, hsmPartitionPassword, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateHsmConfigurationApi#createHsmConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateHsmConfigurationApi;

public class CreateHsmConfigurationApiExample {

    public static void main(String[] args) {
        CreateHsmConfigurationApi apiInstance = new CreateHsmConfigurationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String description = description_example; // String | A text description of the HSM configuration to be created.
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | The identifier to be assigned to the new Amazon Redshift HSM configuration.
        String hsmIpAddress = hsmIpAddress_example; // String | The IP address that the Amazon Redshift cluster must use to access the HSM.
        String hsmPartitionName = hsmPartitionName_example; // String | The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
        String hsmPartitionPassword = hsmPartitionPassword_example; // String | The password required to access the HSM partition.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_13 result = apiInstance.createHsmConfiguration(apiecoKey, description, hsmConfigurationIdentifier, hsmIpAddress, hsmPartitionName, hsmPartitionPassword, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateHsmConfigurationApi#createHsmConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *description = description_example; // A text description of the HSM configuration to be created.
String *hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // The identifier to be assigned to the new Amazon Redshift HSM configuration.
String *hsmIpAddress = hsmIpAddress_example; // The IP address that the Amazon Redshift cluster must use to access the HSM.
String *hsmPartitionName = hsmPartitionName_example; // The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
String *hsmPartitionPassword = hsmPartitionPassword_example; // The password required to access the HSM partition.
array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateHsmConfigurationApi *apiInstance = [[CreateHsmConfigurationApi alloc] init];

[apiInstance createHsmConfigurationWith:apiecoKey
    description:description
    hsmConfigurationIdentifier:hsmConfigurationIdentifier
    hsmIpAddress:hsmIpAddress
    hsmPartitionName:hsmPartitionName
    hsmPartitionPassword:hsmPartitionPassword
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_13 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateHsmConfigurationApi()

var apiecoKey = apiecoKey_example; // {String} 

var description = description_example; // {String} A text description of the HSM configuration to be created.

var hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // {String} The identifier to be assigned to the new Amazon Redshift HSM configuration.

var hsmIpAddress = hsmIpAddress_example; // {String} The IP address that the Amazon Redshift cluster must use to access the HSM.

var hsmPartitionName = hsmPartitionName_example; // {String} The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

var hsmPartitionPassword = hsmPartitionPassword_example; // {String} The password required to access the HSM partition.

var opts = { 
  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHsmConfiguration(apiecoKey, description, hsmConfigurationIdentifier, hsmIpAddress, hsmPartitionName, hsmPartitionPassword, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createHsmConfigurationExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateHsmConfigurationApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var description = description_example;  // String | A text description of the HSM configuration to be created.
            var hsmConfigurationIdentifier = hsmConfigurationIdentifier_example;  // String | The identifier to be assigned to the new Amazon Redshift HSM configuration.
            var hsmIpAddress = hsmIpAddress_example;  // String | The IP address that the Amazon Redshift cluster must use to access the HSM.
            var hsmPartitionName = hsmPartitionName_example;  // String | The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
            var hsmPartitionPassword = hsmPartitionPassword_example;  // String | The password required to access the HSM partition.
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_13 result = apiInstance.createHsmConfiguration(apiecoKey, description, hsmConfigurationIdentifier, hsmIpAddress, hsmPartitionName, hsmPartitionPassword, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateHsmConfigurationApi.createHsmConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateHsmConfigurationApi();
$apiecoKey = apiecoKey_example; // String | 
$description = description_example; // String | A text description of the HSM configuration to be created.
$hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | The identifier to be assigned to the new Amazon Redshift HSM configuration.
$hsmIpAddress = hsmIpAddress_example; // String | The IP address that the Amazon Redshift cluster must use to access the HSM.
$hsmPartitionName = hsmPartitionName_example; // String | The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
$hsmPartitionPassword = hsmPartitionPassword_example; // String | The password required to access the HSM partition.
$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createHsmConfiguration($apiecoKey, $description, $hsmConfigurationIdentifier, $hsmIpAddress, $hsmPartitionName, $hsmPartitionPassword, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateHsmConfigurationApi->createHsmConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateHsmConfigurationApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateHsmConfigurationApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $description = description_example; # String | A text description of the HSM configuration to be created.
my $hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; # String | The identifier to be assigned to the new Amazon Redshift HSM configuration.
my $hsmIpAddress = hsmIpAddress_example; # String | The IP address that the Amazon Redshift cluster must use to access the HSM.
my $hsmPartitionName = hsmPartitionName_example; # String | The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
my $hsmPartitionPassword = hsmPartitionPassword_example; # String | The password required to access the HSM partition.
my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createHsmConfiguration(apiecoKey => $apiecoKey, description => $description, hsmConfigurationIdentifier => $hsmConfigurationIdentifier, hsmIpAddress => $hsmIpAddress, hsmPartitionName => $hsmPartitionName, hsmPartitionPassword => $hsmPartitionPassword, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateHsmConfigurationApi->createHsmConfiguration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateHsmConfigurationApi()
apiecoKey = apiecoKey_example # String | 
description = description_example # String | A text description of the HSM configuration to be created.
hsmConfigurationIdentifier = hsmConfigurationIdentifier_example # String | The identifier to be assigned to the new Amazon Redshift HSM configuration.
hsmIpAddress = hsmIpAddress_example # String | The IP address that the Amazon Redshift cluster must use to access the HSM.
hsmPartitionName = hsmPartitionName_example # String | The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
hsmPartitionPassword = hsmPartitionPassword_example # String | The password required to access the HSM partition.
tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_hsm_configuration(apiecoKey, description, hsmConfigurationIdentifier, hsmIpAddress, hsmPartitionName, hsmPartitionPassword, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateHsmConfigurationApi->createHsmConfiguration: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
Description*
String
A text description of the HSM configuration to be created.
Required
HsmConfigurationIdentifier*
String
The identifier to be assigned to the new Amazon Redshift HSM configuration.
Required
HsmIpAddress*
String
The IP address that the Amazon Redshift cluster must use to access the HSM.
Required
HsmPartitionName*
String
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
Required
HsmPartitionPassword*
String
The password required to access the HSM partition.
Required
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateSnapshotCopyGrant

createSnapshotCopyGrant

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.


/CreateSnapshotCopyGrant

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateSnapshotCopyGrant?SnapshotCopyGrantName=&KmsKeyId=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateSnapshotCopyGrantApi;

import java.io.File;
import java.util.*;

public class CreateSnapshotCopyGrantApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateSnapshotCopyGrantApi apiInstance = new CreateSnapshotCopyGrantApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
        String kmsKeyId = kmsKeyId_example; // String | The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_14 result = apiInstance.createSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName, kmsKeyId, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateSnapshotCopyGrantApi#createSnapshotCopyGrant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateSnapshotCopyGrantApi;

public class CreateSnapshotCopyGrantApiExample {

    public static void main(String[] args) {
        CreateSnapshotCopyGrantApi apiInstance = new CreateSnapshotCopyGrantApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
        String kmsKeyId = kmsKeyId_example; // String | The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_14 result = apiInstance.createSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName, kmsKeyId, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateSnapshotCopyGrantApi#createSnapshotCopyGrant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *snapshotCopyGrantName = snapshotCopyGrantName_example; // The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
String *kmsKeyId = kmsKeyId_example; // The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateSnapshotCopyGrantApi *apiInstance = [[CreateSnapshotCopyGrantApi alloc] init];

[apiInstance createSnapshotCopyGrantWith:apiecoKey
    snapshotCopyGrantName:snapshotCopyGrantName
    kmsKeyId:kmsKeyId
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_14 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateSnapshotCopyGrantApi()

var apiecoKey = apiecoKey_example; // {String} 

var snapshotCopyGrantName = snapshotCopyGrantName_example; // {String} The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..

var kmsKeyId = kmsKeyId_example; // {String} The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

var opts = { 
  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName, kmsKeyId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSnapshotCopyGrantExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateSnapshotCopyGrantApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var snapshotCopyGrantName = snapshotCopyGrantName_example;  // String | The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
            var kmsKeyId = kmsKeyId_example;  // String | The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_14 result = apiInstance.createSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName, kmsKeyId, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateSnapshotCopyGrantApi.createSnapshotCopyGrant: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateSnapshotCopyGrantApi();
$apiecoKey = apiecoKey_example; // String | 
$snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
$kmsKeyId = kmsKeyId_example; // String | The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createSnapshotCopyGrant($apiecoKey, $snapshotCopyGrantName, $kmsKeyId, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateSnapshotCopyGrantApi->createSnapshotCopyGrant: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateSnapshotCopyGrantApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateSnapshotCopyGrantApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $snapshotCopyGrantName = snapshotCopyGrantName_example; # String | The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
my $kmsKeyId = kmsKeyId_example; # String | The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createSnapshotCopyGrant(apiecoKey => $apiecoKey, snapshotCopyGrantName => $snapshotCopyGrantName, kmsKeyId => $kmsKeyId, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateSnapshotCopyGrantApi->createSnapshotCopyGrant: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateSnapshotCopyGrantApi()
apiecoKey = apiecoKey_example # String | 
snapshotCopyGrantName = snapshotCopyGrantName_example # String | The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account..
kmsKeyId = kmsKeyId_example # String | The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_snapshot_copy_grant(apiecoKey, snapshotCopyGrantName, kmsKeyId, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateSnapshotCopyGrantApi->createSnapshotCopyGrant: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SnapshotCopyGrantName*
String
The name of the snapshot copy grant. This name must be unique in the region for the AWS account. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account..
Required
KmsKeyId*
String
The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
Required
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateSnapshotSchedule

createSnapshotSchedule

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.


/CreateSnapshotSchedule

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateSnapshotSchedule?DryRun=&NextInvocations=&ScheduleDefinitions.ScheduleDefinition.N=&ScheduleDescription=&ScheduleIdentifier=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateSnapshotScheduleApi;

import java.io.File;
import java.util.*;

public class CreateSnapshotScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateSnapshotScheduleApi apiInstance = new CreateSnapshotScheduleApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean dryRun = true; // Boolean | 
        Integer nextInvocations = 56; // Integer | 
        array[String] scheduleDefinitions.ScheduleDefinition.N = ; // array[String] | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
        Integer scheduleDescription = 56; // Integer | The description of the snapshot schedule.
        Integer scheduleIdentifier = 56; // Integer | A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_15 result = apiInstance.createSnapshotSchedule(apiecoKey, dryRun, nextInvocations, scheduleDefinitions.ScheduleDefinition.N, scheduleDescription, scheduleIdentifier, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateSnapshotScheduleApi#createSnapshotSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateSnapshotScheduleApi;

public class CreateSnapshotScheduleApiExample {

    public static void main(String[] args) {
        CreateSnapshotScheduleApi apiInstance = new CreateSnapshotScheduleApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean dryRun = true; // Boolean | 
        Integer nextInvocations = 56; // Integer | 
        array[String] scheduleDefinitions.ScheduleDefinition.N = ; // array[String] | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
        Integer scheduleDescription = 56; // Integer | The description of the snapshot schedule.
        Integer scheduleIdentifier = 56; // Integer | A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
        array[String] tags.Tag.N = ; // array[String] | A list of tag instances.
        try {
            inline_response_200_15 result = apiInstance.createSnapshotSchedule(apiecoKey, dryRun, nextInvocations, scheduleDefinitions.ScheduleDefinition.N, scheduleDescription, scheduleIdentifier, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateSnapshotScheduleApi#createSnapshotSchedule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
Boolean *dryRun = true; //  (optional)
Integer *nextInvocations = 56; //  (optional)
array[String] *scheduleDefinitions.ScheduleDefinition.N = ; // The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)". (optional)
Integer *scheduleDescription = 56; // The description of the snapshot schedule. (optional)
Integer *scheduleIdentifier = 56; // A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier. (optional)
array[String] *tags.Tag.N = ; // A list of tag instances. (optional)

CreateSnapshotScheduleApi *apiInstance = [[CreateSnapshotScheduleApi alloc] init];

[apiInstance createSnapshotScheduleWith:apiecoKey
    dryRun:dryRun
    nextInvocations:nextInvocations
    scheduleDefinitions.ScheduleDefinition.N:scheduleDefinitions.ScheduleDefinition.N
    scheduleDescription:scheduleDescription
    scheduleIdentifier:scheduleIdentifier
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_15 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateSnapshotScheduleApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'dryRun': true, // {Boolean} 
  'nextInvocations': 56, // {Integer} 
  'scheduleDefinitions.ScheduleDefinition.N': , // {array[String]} The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
  'scheduleDescription': 56, // {Integer} The description of the snapshot schedule.
  'scheduleIdentifier': 56, // {Integer} A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
  'tags.Tag.N':  // {array[String]} A list of tag instances.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSnapshotSchedule(apiecoKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSnapshotScheduleExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateSnapshotScheduleApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var dryRun = true;  // Boolean |  (optional) 
            var nextInvocations = 56;  // Integer |  (optional) 
            var scheduleDefinitions.ScheduleDefinition.N = new array[String](); // array[String] | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)". (optional) 
            var scheduleDescription = 56;  // Integer | The description of the snapshot schedule. (optional) 
            var scheduleIdentifier = 56;  // Integer | A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier. (optional) 
            var tags.Tag.N = new array[String](); // array[String] | A list of tag instances. (optional) 

            try
            {
                inline_response_200_15 result = apiInstance.createSnapshotSchedule(apiecoKey, dryRun, nextInvocations, scheduleDefinitions.ScheduleDefinition.N, scheduleDescription, scheduleIdentifier, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateSnapshotScheduleApi.createSnapshotSchedule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateSnapshotScheduleApi();
$apiecoKey = apiecoKey_example; // String | 
$dryRun = true; // Boolean | 
$nextInvocations = 56; // Integer | 
$scheduleDefinitions.ScheduleDefinition.N = ; // array[String] | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
$scheduleDescription = 56; // Integer | The description of the snapshot schedule.
$scheduleIdentifier = 56; // Integer | A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
$tags.Tag.N = ; // array[String] | A list of tag instances.

try {
    $result = $api_instance->createSnapshotSchedule($apiecoKey, $dryRun, $nextInvocations, $scheduleDefinitions.ScheduleDefinition.N, $scheduleDescription, $scheduleIdentifier, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateSnapshotScheduleApi->createSnapshotSchedule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateSnapshotScheduleApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateSnapshotScheduleApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $dryRun = true; # Boolean | 
my $nextInvocations = 56; # Integer | 
my $scheduleDefinitions.ScheduleDefinition.N = []; # array[String] | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
my $scheduleDescription = 56; # Integer | The description of the snapshot schedule.
my $scheduleIdentifier = 56; # Integer | A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
my $tags.Tag.N = []; # array[String] | A list of tag instances.

eval { 
    my $result = $api_instance->createSnapshotSchedule(apiecoKey => $apiecoKey, dryRun => $dryRun, nextInvocations => $nextInvocations, scheduleDefinitions.ScheduleDefinition.N => $scheduleDefinitions.ScheduleDefinition.N, scheduleDescription => $scheduleDescription, scheduleIdentifier => $scheduleIdentifier, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateSnapshotScheduleApi->createSnapshotSchedule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateSnapshotScheduleApi()
apiecoKey = apiecoKey_example # String | 
dryRun = true # Boolean |  (optional)
nextInvocations = 56 # Integer |  (optional)
scheduleDefinitions.ScheduleDefinition.N =  # array[String] | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)". (optional)
scheduleDescription = 56 # Integer | The description of the snapshot schedule. (optional)
scheduleIdentifier = 56 # Integer | A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier. (optional)
tags.Tag.N =  # array[String] | A list of tag instances. (optional)

try: 
    api_response = api_instance.create_snapshot_schedule(apiecoKey, dryRun=dryRun, nextInvocations=nextInvocations, scheduleDefinitions.ScheduleDefinition.N=scheduleDefinitions.ScheduleDefinition.N, scheduleDescription=scheduleDescription, scheduleIdentifier=scheduleIdentifier, tags.Tag.N=tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateSnapshotScheduleApi->createSnapshotSchedule: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
DryRun
Boolean
NextInvocations
Integer
ScheduleDefinitions.ScheduleDefinition.N
array[String]
The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
ScheduleDescription
Integer
The description of the snapshot schedule.
ScheduleIdentifier
Integer
A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
Tags.Tag.N
array[String]
A list of tag instances.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


CreateTags

createTags

Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value.


/CreateTags

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/CreateTags?ResourceName=&Tags.Tag.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CreateTagsApi;

import java.io.File;
import java.util.*;

public class CreateTagsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CreateTagsApi apiInstance = new CreateTagsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        array[String] tags.Tag.N = ; // array[String] | One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".
        try {
            inline_response_200_15 result = apiInstance.createTags(apiecoKey, resourceName, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateTagsApi#createTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CreateTagsApi;

public class CreateTagsApiExample {

    public static void main(String[] args) {
        CreateTagsApi apiInstance = new CreateTagsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        array[String] tags.Tag.N = ; // array[String] | One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".
        try {
            inline_response_200_15 result = apiInstance.createTags(apiecoKey, resourceName, tags.Tag.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateTagsApi#createTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *resourceName = resourceName_example; // The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
array[String] *tags.Tag.N = ; // One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

CreateTagsApi *apiInstance = [[CreateTagsApi alloc] init];

[apiInstance createTagsWith:apiecoKey
    resourceName:resourceName
    tags.Tag.N:tags.Tag.N
              completionHandler: ^(inline_response_200_15 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.CreateTagsApi()

var apiecoKey = apiecoKey_example; // {String} 

var resourceName = resourceName_example; // {String} The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

var tags.Tag.N = ; // {array[String]} One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTags(apiecoKey, resourceName, tags.Tag.N, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTagsExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CreateTagsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var resourceName = resourceName_example;  // String | The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
            var tags.Tag.N = new array[String](); // array[String] | One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

            try
            {
                inline_response_200_15 result = apiInstance.createTags(apiecoKey, resourceName, tags.Tag.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateTagsApi.createTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CreateTagsApi();
$apiecoKey = apiecoKey_example; // String | 
$resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
$tags.Tag.N = ; // array[String] | One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

try {
    $result = $api_instance->createTags($apiecoKey, $resourceName, $tags.Tag.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateTagsApi->createTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CreateTagsApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CreateTagsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $resourceName = resourceName_example; # String | The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
my $tags.Tag.N = []; # array[String] | One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

eval { 
    my $result = $api_instance->createTags(apiecoKey => $apiecoKey, resourceName => $resourceName, tags.Tag.N => $tags.Tag.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreateTagsApi->createTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CreateTagsApi()
apiecoKey = apiecoKey_example # String | 
resourceName = resourceName_example # String | The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
tags.Tag.N =  # array[String] | One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

try: 
    api_response = api_instance.create_tags(apiecoKey, resourceName, tags.Tag.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreateTagsApi->createTags: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ResourceName*
String
The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
Required
Tags.Tag.N*
array[String]
One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteCluster

deleteCluster

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it`s "deleting" once Amazon Redshift begins deleting the cluster.


/DeleteCluster

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteCluster?ClusterIdentifier=&FinalClusterSnapshotIdentifier=&FinalClusterSnapshotRetentionPeriod=&SkipFinalClusterSnapshot="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteClusterApi;

import java.io.File;
import java.util.*;

public class DeleteClusterApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteClusterApi apiInstance = new DeleteClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        String finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example; // String | The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        String finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example; // String | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
        Boolean skipFinalClusterSnapshot = true; // Boolean | Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.
        try {
            inline_response_200_16 result = apiInstance.deleteCluster(apiecoKey, clusterIdentifier, finalClusterSnapshotIdentifier, finalClusterSnapshotRetentionPeriod, skipFinalClusterSnapshot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterApi#deleteCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteClusterApi;

public class DeleteClusterApiExample {

    public static void main(String[] args) {
        DeleteClusterApi apiInstance = new DeleteClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        String finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example; // String | The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
        String finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example; // String | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
        Boolean skipFinalClusterSnapshot = true; // Boolean | Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.
        try {
            inline_response_200_16 result = apiInstance.deleteCluster(apiecoKey, clusterIdentifier, finalClusterSnapshotIdentifier, finalClusterSnapshotRetentionPeriod, skipFinalClusterSnapshot);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterApi#deleteCluster");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterIdentifier = clusterIdentifier_example; // The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
String *finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example; // The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens. (optional)
String *finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example; // The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1. (optional)
Boolean *skipFinalClusterSnapshot = true; // Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. (optional)

DeleteClusterApi *apiInstance = [[DeleteClusterApi alloc] init];

[apiInstance deleteClusterWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    finalClusterSnapshotIdentifier:finalClusterSnapshotIdentifier
    finalClusterSnapshotRetentionPeriod:finalClusterSnapshotRetentionPeriod
    skipFinalClusterSnapshot:skipFinalClusterSnapshot
              completionHandler: ^(inline_response_200_16 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteClusterApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

var opts = { 
  'finalClusterSnapshotIdentifier': finalClusterSnapshotIdentifier_example, // {String} The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
  'finalClusterSnapshotRetentionPeriod': finalClusterSnapshotRetentionPeriod_example, // {String} The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
  'skipFinalClusterSnapshot': true // {Boolean} Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCluster(apiecoKey, clusterIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteClusterExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteClusterApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
            var finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example;  // String | The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens. (optional) 
            var finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example;  // String | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1. (optional) 
            var skipFinalClusterSnapshot = true;  // Boolean | Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. (optional) 

            try
            {
                inline_response_200_16 result = apiInstance.deleteCluster(apiecoKey, clusterIdentifier, finalClusterSnapshotIdentifier, finalClusterSnapshotRetentionPeriod, skipFinalClusterSnapshot);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteClusterApi.deleteCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteClusterApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
$finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example; // String | The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
$finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example; // String | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
$skipFinalClusterSnapshot = true; // Boolean | Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

try {
    $result = $api_instance->deleteCluster($apiecoKey, $clusterIdentifier, $finalClusterSnapshotIdentifier, $finalClusterSnapshotRetentionPeriod, $skipFinalClusterSnapshot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteClusterApi->deleteCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteClusterApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteClusterApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
my $finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example; # String | The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
my $finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example; # String | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
my $skipFinalClusterSnapshot = true; # Boolean | Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

eval { 
    my $result = $api_instance->deleteCluster(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, finalClusterSnapshotIdentifier => $finalClusterSnapshotIdentifier, finalClusterSnapshotRetentionPeriod => $finalClusterSnapshotRetentionPeriod, skipFinalClusterSnapshot => $skipFinalClusterSnapshot);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteClusterApi->deleteCluster: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteClusterApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
finalClusterSnapshotIdentifier = finalClusterSnapshotIdentifier_example # String | The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens. (optional)
finalClusterSnapshotRetentionPeriod = finalClusterSnapshotRetentionPeriod_example # String | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1. (optional)
skipFinalClusterSnapshot = true # Boolean | Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. (optional)

try: 
    api_response = api_instance.delete_cluster(apiecoKey, clusterIdentifier, finalClusterSnapshotIdentifier=finalClusterSnapshotIdentifier, finalClusterSnapshotRetentionPeriod=finalClusterSnapshotRetentionPeriod, skipFinalClusterSnapshot=skipFinalClusterSnapshot)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteClusterApi->deleteCluster: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The identifier of the cluster to be deleted. Constraints: Must contain lowercase characters. Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
Required
FinalClusterSnapshotIdentifier
String
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false. Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
FinalClusterSnapshotRetentionPeriod
String
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
SkipFinalClusterSnapshot
Boolean
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteClusterParameterGroup

deleteClusterParameterGroup

Deletes a specified Amazon Redshift parameter group. Note You cannot delete a parameter group if it is associated with a cluster.


/DeleteClusterParameterGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteClusterParameterGroup?ParameterGroupName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteClusterParameterGroupApi;

import java.io.File;
import java.util.*;

public class DeleteClusterParameterGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteClusterParameterGroupApi apiInstance = new DeleteClusterParameterGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.
        try {
            inline_response_200_17 result = apiInstance.deleteClusterParameterGroup(apiecoKey, parameterGroupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterParameterGroupApi#deleteClusterParameterGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteClusterParameterGroupApi;

public class DeleteClusterParameterGroupApiExample {

    public static void main(String[] args) {
        DeleteClusterParameterGroupApi apiInstance = new DeleteClusterParameterGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.
        try {
            inline_response_200_17 result = apiInstance.deleteClusterParameterGroup(apiecoKey, parameterGroupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterParameterGroupApi#deleteClusterParameterGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *parameterGroupName = parameterGroupName_example; // The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group. (optional)

DeleteClusterParameterGroupApi *apiInstance = [[DeleteClusterParameterGroupApi alloc] init];

[apiInstance deleteClusterParameterGroupWith:apiecoKey
    parameterGroupName:parameterGroupName
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteClusterParameterGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'parameterGroupName': parameterGroupName_example // {String} The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteClusterParameterGroup(apiecoKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteClusterParameterGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteClusterParameterGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var parameterGroupName = parameterGroupName_example;  // String | The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group. (optional) 

            try
            {
                inline_response_200_17 result = apiInstance.deleteClusterParameterGroup(apiecoKey, parameterGroupName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteClusterParameterGroupApi.deleteClusterParameterGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteClusterParameterGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$parameterGroupName = parameterGroupName_example; // String | The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.

try {
    $result = $api_instance->deleteClusterParameterGroup($apiecoKey, $parameterGroupName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteClusterParameterGroupApi->deleteClusterParameterGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteClusterParameterGroupApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteClusterParameterGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $parameterGroupName = parameterGroupName_example; # String | The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.

eval { 
    my $result = $api_instance->deleteClusterParameterGroup(apiecoKey => $apiecoKey, parameterGroupName => $parameterGroupName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteClusterParameterGroupApi->deleteClusterParameterGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteClusterParameterGroupApi()
apiecoKey = apiecoKey_example # String | 
parameterGroupName = parameterGroupName_example # String | The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group. (optional)

try: 
    api_response = api_instance.delete_cluster_parameter_group(apiecoKey, parameterGroupName=parameterGroupName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteClusterParameterGroupApi->deleteClusterParameterGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ParameterGroupName
String
The name of the parameter group to be deleted. Constraints: Must be the name of an existing cluster parameter group. Cannot delete a default cluster parameter group.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteClusterSecurityGroup

deleteClusterSecurityGroup

Deletes an Amazon Redshift security group. Note You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.


/DeleteClusterSecurityGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteClusterSecurityGroup?ClusterSecurityGroupName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteClusterSecurityGroupApi;

import java.io.File;
import java.util.*;

public class DeleteClusterSecurityGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteClusterSecurityGroupApi apiInstance = new DeleteClusterSecurityGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of the cluster security group to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteClusterSecurityGroup(apiecoKey, clusterSecurityGroupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterSecurityGroupApi#deleteClusterSecurityGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteClusterSecurityGroupApi;

public class DeleteClusterSecurityGroupApiExample {

    public static void main(String[] args) {
        DeleteClusterSecurityGroupApi apiInstance = new DeleteClusterSecurityGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of the cluster security group to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteClusterSecurityGroup(apiecoKey, clusterSecurityGroupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterSecurityGroupApi#deleteClusterSecurityGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterSecurityGroupName = clusterSecurityGroupName_example; // The name of the cluster security group to be deleted.

DeleteClusterSecurityGroupApi *apiInstance = [[DeleteClusterSecurityGroupApi alloc] init];

[apiInstance deleteClusterSecurityGroupWith:apiecoKey
    clusterSecurityGroupName:clusterSecurityGroupName
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteClusterSecurityGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterSecurityGroupName = clusterSecurityGroupName_example; // {String} The name of the cluster security group to be deleted.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteClusterSecurityGroup(apiecoKey, clusterSecurityGroupName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteClusterSecurityGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteClusterSecurityGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSecurityGroupName = clusterSecurityGroupName_example;  // String | The name of the cluster security group to be deleted.

            try
            {
                inline_response_200_17 result = apiInstance.deleteClusterSecurityGroup(apiecoKey, clusterSecurityGroupName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteClusterSecurityGroupApi.deleteClusterSecurityGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteClusterSecurityGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of the cluster security group to be deleted.

try {
    $result = $api_instance->deleteClusterSecurityGroup($apiecoKey, $clusterSecurityGroupName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteClusterSecurityGroupApi->deleteClusterSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteClusterSecurityGroupApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteClusterSecurityGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSecurityGroupName = clusterSecurityGroupName_example; # String | The name of the cluster security group to be deleted.

eval { 
    my $result = $api_instance->deleteClusterSecurityGroup(apiecoKey => $apiecoKey, clusterSecurityGroupName => $clusterSecurityGroupName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteClusterSecurityGroupApi->deleteClusterSecurityGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteClusterSecurityGroupApi()
apiecoKey = apiecoKey_example # String | 
clusterSecurityGroupName = clusterSecurityGroupName_example # String | The name of the cluster security group to be deleted.

try: 
    api_response = api_instance.delete_cluster_security_group(apiecoKey, clusterSecurityGroupName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteClusterSecurityGroupApi->deleteClusterSecurityGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSecurityGroupName*
String
The name of the cluster security group to be deleted.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteClusterSnapshot

deleteClusterSnapshot

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.


/DeleteClusterSnapshot

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteClusterSnapshot?SnapshotIdentifier=&SnapshotClusterIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteClusterSnapshotApi;

import java.io.File;
import java.util.*;

public class DeleteClusterSnapshotApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteClusterSnapshotApi apiInstance = new DeleteClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotIdentifier = snapshotIdentifier_example; // String | The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
        String snapshotClusterIdentifier = snapshotClusterIdentifier_example; // String | The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
        try {
            inline_response_200_6_snapshot result = apiInstance.deleteClusterSnapshot(apiecoKey, snapshotIdentifier, snapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterSnapshotApi#deleteClusterSnapshot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteClusterSnapshotApi;

public class DeleteClusterSnapshotApiExample {

    public static void main(String[] args) {
        DeleteClusterSnapshotApi apiInstance = new DeleteClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotIdentifier = snapshotIdentifier_example; // String | The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
        String snapshotClusterIdentifier = snapshotClusterIdentifier_example; // String | The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
        try {
            inline_response_200_6_snapshot result = apiInstance.deleteClusterSnapshot(apiecoKey, snapshotIdentifier, snapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterSnapshotApi#deleteClusterSnapshot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *snapshotIdentifier = snapshotIdentifier_example; // The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
String *snapshotClusterIdentifier = snapshotClusterIdentifier_example; // The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster. (optional)

DeleteClusterSnapshotApi *apiInstance = [[DeleteClusterSnapshotApi alloc] init];

[apiInstance deleteClusterSnapshotWith:apiecoKey
    snapshotIdentifier:snapshotIdentifier
    snapshotClusterIdentifier:snapshotClusterIdentifier
              completionHandler: ^(inline_response_200_6_snapshot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteClusterSnapshotApi()

var apiecoKey = apiecoKey_example; // {String} 

var snapshotIdentifier = snapshotIdentifier_example; // {String} The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.

var opts = { 
  'snapshotClusterIdentifier': snapshotClusterIdentifier_example // {String} The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteClusterSnapshot(apiecoKey, snapshotIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteClusterSnapshotExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteClusterSnapshotApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var snapshotIdentifier = snapshotIdentifier_example;  // String | The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
            var snapshotClusterIdentifier = snapshotClusterIdentifier_example;  // String | The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster. (optional) 

            try
            {
                inline_response_200_6_snapshot result = apiInstance.deleteClusterSnapshot(apiecoKey, snapshotIdentifier, snapshotClusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteClusterSnapshotApi.deleteClusterSnapshot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteClusterSnapshotApi();
$apiecoKey = apiecoKey_example; // String | 
$snapshotIdentifier = snapshotIdentifier_example; // String | The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
$snapshotClusterIdentifier = snapshotClusterIdentifier_example; // String | The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.

try {
    $result = $api_instance->deleteClusterSnapshot($apiecoKey, $snapshotIdentifier, $snapshotClusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteClusterSnapshotApi->deleteClusterSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteClusterSnapshotApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteClusterSnapshotApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $snapshotIdentifier = snapshotIdentifier_example; # String | The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
my $snapshotClusterIdentifier = snapshotClusterIdentifier_example; # String | The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.

eval { 
    my $result = $api_instance->deleteClusterSnapshot(apiecoKey => $apiecoKey, snapshotIdentifier => $snapshotIdentifier, snapshotClusterIdentifier => $snapshotClusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteClusterSnapshotApi->deleteClusterSnapshot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteClusterSnapshotApi()
apiecoKey = apiecoKey_example # String | 
snapshotIdentifier = snapshotIdentifier_example # String | The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the             available, failed, or cancelled state.
snapshotClusterIdentifier = snapshotClusterIdentifier_example # String | The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster. (optional)

try: 
    api_response = api_instance.delete_cluster_snapshot(apiecoKey, snapshotIdentifier, snapshotClusterIdentifier=snapshotClusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteClusterSnapshotApi->deleteClusterSnapshot: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SnapshotIdentifier*
String
The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.
Required
SnapshotClusterIdentifier
String
The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteClusterSubnetGroup

deleteClusterSubnetGroup

Deletes the specified cluster subnet group.


/DeleteClusterSubnetGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteClusterSubnetGroup?ClusterSubnetGroupName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteClusterSubnetGroupApi;

import java.io.File;
import java.util.*;

public class DeleteClusterSubnetGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteClusterSubnetGroupApi apiInstance = new DeleteClusterSubnetGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the cluster subnet group name to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteClusterSubnetGroup(apiecoKey, clusterSubnetGroupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterSubnetGroupApi#deleteClusterSubnetGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteClusterSubnetGroupApi;

public class DeleteClusterSubnetGroupApiExample {

    public static void main(String[] args) {
        DeleteClusterSubnetGroupApi apiInstance = new DeleteClusterSubnetGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the cluster subnet group name to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteClusterSubnetGroup(apiecoKey, clusterSubnetGroupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteClusterSubnetGroupApi#deleteClusterSubnetGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *clusterSubnetGroupName = clusterSubnetGroupName_example; // The name of the cluster subnet group name to be deleted.

DeleteClusterSubnetGroupApi *apiInstance = [[DeleteClusterSubnetGroupApi alloc] init];

[apiInstance deleteClusterSubnetGroupWith:apiecoKey
    clusterSubnetGroupName:clusterSubnetGroupName
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteClusterSubnetGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterSubnetGroupName = clusterSubnetGroupName_example; // {String} The name of the cluster subnet group name to be deleted.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteClusterSubnetGroup(apiecoKey, clusterSubnetGroupName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteClusterSubnetGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteClusterSubnetGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSubnetGroupName = clusterSubnetGroupName_example;  // String | The name of the cluster subnet group name to be deleted.

            try
            {
                inline_response_200_17 result = apiInstance.deleteClusterSubnetGroup(apiecoKey, clusterSubnetGroupName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteClusterSubnetGroupApi.deleteClusterSubnetGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteClusterSubnetGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the cluster subnet group name to be deleted.

try {
    $result = $api_instance->deleteClusterSubnetGroup($apiecoKey, $clusterSubnetGroupName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteClusterSubnetGroupApi->deleteClusterSubnetGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteClusterSubnetGroupApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteClusterSubnetGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSubnetGroupName = clusterSubnetGroupName_example; # String | The name of the cluster subnet group name to be deleted.

eval { 
    my $result = $api_instance->deleteClusterSubnetGroup(apiecoKey => $apiecoKey, clusterSubnetGroupName => $clusterSubnetGroupName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteClusterSubnetGroupApi->deleteClusterSubnetGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteClusterSubnetGroupApi()
apiecoKey = apiecoKey_example # String | 
clusterSubnetGroupName = clusterSubnetGroupName_example # String | The name of the cluster subnet group name to be deleted.

try: 
    api_response = api_instance.delete_cluster_subnet_group(apiecoKey, clusterSubnetGroupName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteClusterSubnetGroupApi->deleteClusterSubnetGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSubnetGroupName*
String
The name of the cluster subnet group name to be deleted.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteEventSubscription

deleteEventSubscription

Deletes an Amazon Redshift event notification subscription.


/DeleteEventSubscription

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteEventSubscription?SubscriptionName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteEventSubscriptionApi;

import java.io.File;
import java.util.*;

public class DeleteEventSubscriptionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteEventSubscriptionApi apiInstance = new DeleteEventSubscriptionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String subscriptionName = subscriptionName_example; // String | The name of the Amazon Redshift event notification subscription to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteEventSubscription(apiecoKey, subscriptionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteEventSubscriptionApi#deleteEventSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteEventSubscriptionApi;

public class DeleteEventSubscriptionApiExample {

    public static void main(String[] args) {
        DeleteEventSubscriptionApi apiInstance = new DeleteEventSubscriptionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String subscriptionName = subscriptionName_example; // String | The name of the Amazon Redshift event notification subscription to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteEventSubscription(apiecoKey, subscriptionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteEventSubscriptionApi#deleteEventSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *subscriptionName = subscriptionName_example; // The name of the Amazon Redshift event notification subscription to be deleted.

DeleteEventSubscriptionApi *apiInstance = [[DeleteEventSubscriptionApi alloc] init];

[apiInstance deleteEventSubscriptionWith:apiecoKey
    subscriptionName:subscriptionName
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteEventSubscriptionApi()

var apiecoKey = apiecoKey_example; // {String} 

var subscriptionName = subscriptionName_example; // {String} The name of the Amazon Redshift event notification subscription to be deleted.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteEventSubscription(apiecoKey, subscriptionName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteEventSubscriptionExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteEventSubscriptionApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var subscriptionName = subscriptionName_example;  // String | The name of the Amazon Redshift event notification subscription to be deleted.

            try
            {
                inline_response_200_17 result = apiInstance.deleteEventSubscription(apiecoKey, subscriptionName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteEventSubscriptionApi.deleteEventSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteEventSubscriptionApi();
$apiecoKey = apiecoKey_example; // String | 
$subscriptionName = subscriptionName_example; // String | The name of the Amazon Redshift event notification subscription to be deleted.

try {
    $result = $api_instance->deleteEventSubscription($apiecoKey, $subscriptionName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteEventSubscriptionApi->deleteEventSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteEventSubscriptionApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteEventSubscriptionApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $subscriptionName = subscriptionName_example; # String | The name of the Amazon Redshift event notification subscription to be deleted.

eval { 
    my $result = $api_instance->deleteEventSubscription(apiecoKey => $apiecoKey, subscriptionName => $subscriptionName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteEventSubscriptionApi->deleteEventSubscription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteEventSubscriptionApi()
apiecoKey = apiecoKey_example # String | 
subscriptionName = subscriptionName_example # String | The name of the Amazon Redshift event notification subscription to be deleted.

try: 
    api_response = api_instance.delete_event_subscription(apiecoKey, subscriptionName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteEventSubscriptionApi->deleteEventSubscription: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SubscriptionName*
String
The name of the Amazon Redshift event notification subscription to be deleted.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteHsmClientCertificate

deleteHsmClientCertificate

Deletes the specified HSM client certificate.


/DeleteHsmClientCertificate

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteHsmClientCertificate?HsmClientCertificateIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteHsmClientCertificateApi;

import java.io.File;
import java.util.*;

public class DeleteHsmClientCertificateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        DeleteHsmClientCertificateApi apiInstance = new DeleteHsmClientCertificateApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier of the HSM client certificate to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteHsmClientCertificateApi#deleteHsmClientCertificate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteHsmClientCertificateApi;

public class DeleteHsmClientCertificateApiExample {

    public static void main(String[] args) {
        DeleteHsmClientCertificateApi apiInstance = new DeleteHsmClientCertificateApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier of the HSM client certificate to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteHsmClientCertificateApi#deleteHsmClientCertificate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // 
String *hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // The identifier of the HSM client certificate to be deleted.

DeleteHsmClientCertificateApi *apiInstance = [[DeleteHsmClientCertificateApi alloc] init];

[apiInstance deleteHsmClientCertificateWith:apiecoKey
    hsmClientCertificateIdentifier:hsmClientCertificateIdentifier
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AmazonRedshiftApiDocumentation_ = require('_amazon_redshift_api_documentation_');
var defaultClient = AmazonRedshiftApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new AmazonRedshiftApiDocumentation_.DeleteHsmClientCertificateApi()

var apiecoKey = apiecoKey_example; // {String} 

var hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // {String} The identifier of the HSM client certificate to be deleted.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteHsmClientCertificateExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new DeleteHsmClientCertificateApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example;  // String | The identifier of the HSM client certificate to be deleted.

            try
            {
                inline_response_200_17 result = apiInstance.deleteHsmClientCertificate(apiecoKey, hsmClientCertificateIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteHsmClientCertificateApi.deleteHsmClientCertificate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DeleteHsmClientCertificateApi();
$apiecoKey = apiecoKey_example; // String | 
$hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier of the HSM client certificate to be deleted.

try {
    $result = $api_instance->deleteHsmClientCertificate($apiecoKey, $hsmClientCertificateIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteHsmClientCertificateApi->deleteHsmClientCertificate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeleteHsmClientCertificateApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeleteHsmClientCertificateApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; # String | The identifier of the HSM client certificate to be deleted.

eval { 
    my $result = $api_instance->deleteHsmClientCertificate(apiecoKey => $apiecoKey, hsmClientCertificateIdentifier => $hsmClientCertificateIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteHsmClientCertificateApi->deleteHsmClientCertificate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeleteHsmClientCertificateApi()
apiecoKey = apiecoKey_example # String | 
hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example # String | The identifier of the HSM client certificate to be deleted.

try: 
    api_response = api_instance.delete_hsm_client_certificate(apiecoKey, hsmClientCertificateIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteHsmClientCertificateApi->deleteHsmClientCertificate: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
HsmClientCertificateIdentifier*
String
The identifier of the HSM client certificate to be deleted.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteHsmConfiguration

deleteHsmConfiguration

Deletes the specified Amazon Redshift HSM configuration.


/DeleteHsmConfiguration

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteHsmConfiguration?HsmConfigurationIdentifier="