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="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteHsmConfigurationApi;

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

public class DeleteHsmConfigurationApiExample {

    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");

        DeleteHsmConfigurationApi apiInstance = new DeleteHsmConfigurationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | TThe identifier of the Amazon Redshift HSM configuration to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteHsmConfiguration(apiecoKey, hsmConfigurationIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteHsmConfigurationApi#deleteHsmConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteHsmConfigurationApi;

public class DeleteHsmConfigurationApiExample {

    public static void main(String[] args) {
        DeleteHsmConfigurationApi apiInstance = new DeleteHsmConfigurationApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | TThe identifier of the Amazon Redshift HSM configuration to be deleted.
        try {
            inline_response_200_17 result = apiInstance.deleteHsmConfiguration(apiecoKey, hsmConfigurationIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteHsmConfigurationApi#deleteHsmConfiguration");
            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 *hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // TThe identifier of the Amazon Redshift HSM configuration to be deleted.

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

[apiInstance deleteHsmConfigurationWith:apiecoKey
    hsmConfigurationIdentifier:hsmConfigurationIdentifier
              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_.DeleteHsmConfigurationApi()

var apiecoKey = apiecoKey_example; // {String} 

var hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // {String} TThe identifier of the Amazon Redshift HSM configuration to be deleted.


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

namespace Example
{
    public class deleteHsmConfigurationExample
    {
        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 DeleteHsmConfigurationApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var hsmConfigurationIdentifier = hsmConfigurationIdentifier_example;  // String | TThe identifier of the Amazon Redshift HSM configuration to be deleted.

            try
            {
                inline_response_200_17 result = apiInstance.deleteHsmConfiguration(apiecoKey, hsmConfigurationIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteHsmConfigurationApi.deleteHsmConfiguration: " + 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\DeleteHsmConfigurationApi();
$apiecoKey = apiecoKey_example; // String | 
$hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | TThe identifier of the Amazon Redshift HSM configuration to be deleted.

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

# 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::DeleteHsmConfigurationApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; # String | TThe identifier of the Amazon Redshift HSM configuration to be deleted.

eval { 
    my $result = $api_instance->deleteHsmConfiguration(apiecoKey => $apiecoKey, hsmConfigurationIdentifier => $hsmConfigurationIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteHsmConfigurationApi->deleteHsmConfiguration: $@\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.DeleteHsmConfigurationApi()
apiecoKey = apiecoKey_example # String | 
hsmConfigurationIdentifier = hsmConfigurationIdentifier_example # String | TThe identifier of the Amazon Redshift HSM configuration to be deleted.

try: 
    api_response = api_instance.delete_hsm_configuration(apiecoKey, hsmConfigurationIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteHsmConfigurationApi->deleteHsmConfiguration: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
HsmConfigurationIdentifier*
String
TThe identifier of the Amazon Redshift HSM configuration to be deleted.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteScheduledAction

deleteScheduledAction

DeDeletes a scheduled action.


/DeleteScheduledAction

Usage and SDK Samples

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

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

public class DeleteScheduledActionApiExample {

    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");

        DeleteScheduledActionApi apiInstance = new DeleteScheduledActionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String scheduledActionName = scheduledActionName_example; // String | The name of the scheduled action to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteScheduledAction(apiecoKey, scheduledActionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteScheduledActionApi#deleteScheduledAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteScheduledActionApi;

public class DeleteScheduledActionApiExample {

    public static void main(String[] args) {
        DeleteScheduledActionApi apiInstance = new DeleteScheduledActionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String scheduledActionName = scheduledActionName_example; // String | The name of the scheduled action to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteScheduledAction(apiecoKey, scheduledActionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteScheduledActionApi#deleteScheduledAction");
            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 *scheduledActionName = scheduledActionName_example; // The name of the scheduled action to delete.

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

[apiInstance deleteScheduledActionWith:apiecoKey
    scheduledActionName:scheduledActionName
              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_.DeleteScheduledActionApi()

var apiecoKey = apiecoKey_example; // {String} 

var scheduledActionName = scheduledActionName_example; // {String} The name of the scheduled action to delete.


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

namespace Example
{
    public class deleteScheduledActionExample
    {
        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 DeleteScheduledActionApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var scheduledActionName = scheduledActionName_example;  // String | The name of the scheduled action to delete.

            try
            {
                inline_response_200_17 result = apiInstance.deleteScheduledAction(apiecoKey, scheduledActionName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteScheduledActionApi.deleteScheduledAction: " + 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\DeleteScheduledActionApi();
$apiecoKey = apiecoKey_example; // String | 
$scheduledActionName = scheduledActionName_example; // String | The name of the scheduled action to delete.

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

# 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::DeleteScheduledActionApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $scheduledActionName = scheduledActionName_example; # String | The name of the scheduled action to delete.

eval { 
    my $result = $api_instance->deleteScheduledAction(apiecoKey => $apiecoKey, scheduledActionName => $scheduledActionName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteScheduledActionApi->deleteScheduledAction: $@\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.DeleteScheduledActionApi()
apiecoKey = apiecoKey_example # String | 
scheduledActionName = scheduledActionName_example # String | The name of the scheduled action to delete.

try: 
    api_response = api_instance.delete_scheduled_action(apiecoKey, scheduledActionName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteScheduledActionApi->deleteScheduledAction: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ScheduledActionName*
String
The name of the scheduled action to delete.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteSnapshotCopyGrant

deleteSnapshotCopyGrant

Deletes the specified snapshot copy grant.


/DeleteSnapshotCopyGrant

Usage and SDK Samples

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

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

public class DeleteSnapshotCopyGrantApiExample {

    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");

        DeleteSnapshotCopyGrantApi apiInstance = new DeleteSnapshotCopyGrantApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteSnapshotCopyGrantApi#deleteSnapshotCopyGrant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteSnapshotCopyGrantApi;

public class DeleteSnapshotCopyGrantApiExample {

    public static void main(String[] args) {
        DeleteSnapshotCopyGrantApi apiInstance = new DeleteSnapshotCopyGrantApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteSnapshotCopyGrantApi#deleteSnapshotCopyGrant");
            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 to delete.

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

[apiInstance deleteSnapshotCopyGrantWith:apiecoKey
    snapshotCopyGrantName:snapshotCopyGrantName
              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_.DeleteSnapshotCopyGrantApi()

var apiecoKey = apiecoKey_example; // {String} 

var snapshotCopyGrantName = snapshotCopyGrantName_example; // {String} The name of the snapshot copy grant to delete.


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

namespace Example
{
    public class deleteSnapshotCopyGrantExample
    {
        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 DeleteSnapshotCopyGrantApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var snapshotCopyGrantName = snapshotCopyGrantName_example;  // String | The name of the snapshot copy grant to delete.

            try
            {
                inline_response_200_17 result = apiInstance.deleteSnapshotCopyGrant(apiecoKey, snapshotCopyGrantName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteSnapshotCopyGrantApi.deleteSnapshotCopyGrant: " + 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\DeleteSnapshotCopyGrantApi();
$apiecoKey = apiecoKey_example; // String | 
$snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant to delete.

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

# 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::DeleteSnapshotCopyGrantApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $snapshotCopyGrantName = snapshotCopyGrantName_example; # String | The name of the snapshot copy grant to delete.

eval { 
    my $result = $api_instance->deleteSnapshotCopyGrant(apiecoKey => $apiecoKey, snapshotCopyGrantName => $snapshotCopyGrantName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteSnapshotCopyGrantApi->deleteSnapshotCopyGrant: $@\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.DeleteSnapshotCopyGrantApi()
apiecoKey = apiecoKey_example # String | 
snapshotCopyGrantName = snapshotCopyGrantName_example # String | The name of the snapshot copy grant to delete.

try: 
    api_response = api_instance.delete_snapshot_copy_grant(apiecoKey, snapshotCopyGrantName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteSnapshotCopyGrantApi->deleteSnapshotCopyGrant: %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 to delete.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteSnapshotSchedule

deleteSnapshotSchedule

Deletes a snapshot schedule.


/DeleteSnapshotSchedule

Usage and SDK Samples

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

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

public class DeleteSnapshotScheduleApiExample {

    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");

        DeleteSnapshotScheduleApi apiInstance = new DeleteSnapshotScheduleApi();
        String apiecoKey = apiecoKey_example; // String | 
        String scheduleIdentifier = scheduleIdentifier_example; // String | A unique identifier of the snapshot schedule to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteSnapshotSchedule(apiecoKey, scheduleIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteSnapshotScheduleApi#deleteSnapshotSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteSnapshotScheduleApi;

public class DeleteSnapshotScheduleApiExample {

    public static void main(String[] args) {
        DeleteSnapshotScheduleApi apiInstance = new DeleteSnapshotScheduleApi();
        String apiecoKey = apiecoKey_example; // String | 
        String scheduleIdentifier = scheduleIdentifier_example; // String | A unique identifier of the snapshot schedule to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteSnapshotSchedule(apiecoKey, scheduleIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteSnapshotScheduleApi#deleteSnapshotSchedule");
            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 *scheduleIdentifier = scheduleIdentifier_example; // A unique identifier of the snapshot schedule to delete.

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

[apiInstance deleteSnapshotScheduleWith:apiecoKey
    scheduleIdentifier:scheduleIdentifier
              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_.DeleteSnapshotScheduleApi()

var apiecoKey = apiecoKey_example; // {String} 

var scheduleIdentifier = scheduleIdentifier_example; // {String} A unique identifier of the snapshot schedule to delete.


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

namespace Example
{
    public class deleteSnapshotScheduleExample
    {
        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 DeleteSnapshotScheduleApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var scheduleIdentifier = scheduleIdentifier_example;  // String | A unique identifier of the snapshot schedule to delete.

            try
            {
                inline_response_200_17 result = apiInstance.deleteSnapshotSchedule(apiecoKey, scheduleIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteSnapshotScheduleApi.deleteSnapshotSchedule: " + 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\DeleteSnapshotScheduleApi();
$apiecoKey = apiecoKey_example; // String | 
$scheduleIdentifier = scheduleIdentifier_example; // String | A unique identifier of the snapshot schedule to delete.

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

# 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::DeleteSnapshotScheduleApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $scheduleIdentifier = scheduleIdentifier_example; # String | A unique identifier of the snapshot schedule to delete.

eval { 
    my $result = $api_instance->deleteSnapshotSchedule(apiecoKey => $apiecoKey, scheduleIdentifier => $scheduleIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteSnapshotScheduleApi->deleteSnapshotSchedule: $@\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.DeleteSnapshotScheduleApi()
apiecoKey = apiecoKey_example # String | 
scheduleIdentifier = scheduleIdentifier_example # String | A unique identifier of the snapshot schedule to delete.

try: 
    api_response = api_instance.delete_snapshot_schedule(apiecoKey, scheduleIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteSnapshotScheduleApi->deleteSnapshotSchedule: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ScheduleIdentifier*
String
A unique identifier of the snapshot schedule to delete.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DeleteTags

deleteTags

Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.


/DeleteTags

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DeleteTags?ResourceName=&TagKeys.TagKey.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeleteTagsApi;

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

public class DeleteTagsApiExample {

    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");

        DeleteTagsApi apiInstance = new DeleteTagsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        array[String] tagKeys.TagKey.N = ; // array[String] | The tag key that you want to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteTags(apiecoKey, resourceName, tagKeys.TagKey.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteTagsApi#deleteTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeleteTagsApi;

public class DeleteTagsApiExample {

    public static void main(String[] args) {
        DeleteTagsApi apiInstance = new DeleteTagsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
        array[String] tagKeys.TagKey.N = ; // array[String] | The tag key that you want to delete.
        try {
            inline_response_200_17 result = apiInstance.deleteTags(apiecoKey, resourceName, tagKeys.TagKey.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeleteTagsApi#deleteTags");
            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) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
array[String] *tagKeys.TagKey.N = ; // The tag key that you want to delete.

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

[apiInstance deleteTagsWith:apiecoKey
    resourceName:resourceName
    tagKeys.TagKey.N:tagKeys.TagKey.N
              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_.DeleteTagsApi()

var apiecoKey = apiecoKey_example; // {String} 

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

var tagKeys.TagKey.N = ; // {array[String]} The tag key that you want to delete.


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

namespace Example
{
    public class deleteTagsExample
    {
        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 DeleteTagsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var resourceName = resourceName_example;  // String | The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
            var tagKeys.TagKey.N = new array[String](); // array[String] | The tag key that you want to delete.

            try
            {
                inline_response_200_17 result = apiInstance.deleteTags(apiecoKey, resourceName, tagKeys.TagKey.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeleteTagsApi.deleteTags: " + 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\DeleteTagsApi();
$apiecoKey = apiecoKey_example; // String | 
$resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
$tagKeys.TagKey.N = ; // array[String] | The tag key that you want to delete.

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

# 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::DeleteTagsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $resourceName = resourceName_example; # String | The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
my $tagKeys.TagKey.N = []; # array[String] | The tag key that you want to delete.

eval { 
    my $result = $api_instance->deleteTags(apiecoKey => $apiecoKey, resourceName => $resourceName, tagKeys.TagKey.N => $tagKeys.TagKey.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeleteTagsApi->deleteTags: $@\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.DeleteTagsApi()
apiecoKey = apiecoKey_example # String | 
resourceName = resourceName_example # String | The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
tagKeys.TagKey.N =  # array[String] | The tag key that you want to delete.

try: 
    api_response = api_instance.delete_tags(apiecoKey, resourceName, tagKeys.TagKey.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeleteTagsApi->deleteTags: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ResourceName*
String
The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
Required
TagKeys.TagKey.N*
array[String]
The tag key that you want to delete.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeAccountAttributes

describeAccountAttributes

Returns a list of attributes attached to an account


/DescribeAccountAttributes

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeAccountAttributes?AttributeNames.AttributeName.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeAccountAttributesApi;

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

public class DescribeAccountAttributesApiExample {

    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");

        DescribeAccountAttributesApi apiInstance = new DescribeAccountAttributesApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] attributeNames.AttributeName.N = ; // array[String] | A list of attribute names.
        try {
            inline_response_200_18 result = apiInstance.describeAccountAttributes(apiecoKey, attributeNames.AttributeName.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeAccountAttributesApi#describeAccountAttributes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeAccountAttributesApi;

public class DescribeAccountAttributesApiExample {

    public static void main(String[] args) {
        DescribeAccountAttributesApi apiInstance = new DescribeAccountAttributesApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] attributeNames.AttributeName.N = ; // array[String] | A list of attribute names.
        try {
            inline_response_200_18 result = apiInstance.describeAccountAttributes(apiecoKey, attributeNames.AttributeName.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeAccountAttributesApi#describeAccountAttributes");
            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] *attributeNames.AttributeName.N = ; // A list of attribute names.

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

[apiInstance describeAccountAttributesWith:apiecoKey
    attributeNames.AttributeName.N:attributeNames.AttributeName.N
              completionHandler: ^(inline_response_200_18 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_.DescribeAccountAttributesApi()

var apiecoKey = apiecoKey_example; // {String} 

var attributeNames.AttributeName.N = ; // {array[String]} A list of attribute names.


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

namespace Example
{
    public class describeAccountAttributesExample
    {
        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 DescribeAccountAttributesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var attributeNames.AttributeName.N = new array[String](); // array[String] | A list of attribute names.

            try
            {
                inline_response_200_18 result = apiInstance.describeAccountAttributes(apiecoKey, attributeNames.AttributeName.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeAccountAttributesApi.describeAccountAttributes: " + 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\DescribeAccountAttributesApi();
$apiecoKey = apiecoKey_example; // String | 
$attributeNames.AttributeName.N = ; // array[String] | A list of attribute names.

try {
    $result = $api_instance->describeAccountAttributes($apiecoKey, $attributeNames.AttributeName.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeAccountAttributesApi->describeAccountAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeAccountAttributesApi;

# 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::DescribeAccountAttributesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $attributeNames.AttributeName.N = []; # array[String] | A list of attribute names.

eval { 
    my $result = $api_instance->describeAccountAttributes(apiecoKey => $apiecoKey, attributeNames.AttributeName.N => $attributeNames.AttributeName.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeAccountAttributesApi->describeAccountAttributes: $@\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.DescribeAccountAttributesApi()
apiecoKey = apiecoKey_example # String | 
attributeNames.AttributeName.N =  # array[String] | A list of attribute names.

try: 
    api_response = api_instance.describe_account_attributes(apiecoKey, attributeNames.AttributeName.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeAccountAttributesApi->describeAccountAttributes: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
AttributeNames.AttributeName.N*
array[String]
A list of attribute names.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterDbRevisions

describeClusterDbRevisions

Returns an array of ClusterDbRevision objects.


/DescribeClusterDbRevisions

Usage and SDK Samples

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

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

public class DescribeClusterDbRevisionsApiExample {

    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");

        DescribeClusterDbRevisionsApi apiInstance = new DescribeClusterDbRevisionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
        String marker = marker_example; // String | An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
        String maxRecords = maxRecords_example; // String | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_19 result = apiInstance.describeClusterDbRevisions(apiecoKey, clusterIdentifier, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterDbRevisionsApi#describeClusterDbRevisions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterDbRevisionsApi;

public class DescribeClusterDbRevisionsApiExample {

    public static void main(String[] args) {
        DescribeClusterDbRevisionsApi apiInstance = new DescribeClusterDbRevisionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
        String marker = marker_example; // String | An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
        String maxRecords = maxRecords_example; // String | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_19 result = apiInstance.describeClusterDbRevisions(apiecoKey, clusterIdentifier, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterDbRevisionsApi#describeClusterDbRevisions");
            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 a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
String *marker = marker_example; // An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both. (optional)
String *maxRecords = maxRecords_example; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeClusterDbRevisionsWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_19 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_.DescribeClusterDbRevisionsApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

var opts = { 
  'marker': marker_example, // {String} An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
  'maxRecords': maxRecords_example // {String} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.describeClusterDbRevisions(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 describeClusterDbRevisionsExample
    {
        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 DescribeClusterDbRevisionsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
            var marker = marker_example;  // String | An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both. (optional) 
            var maxRecords = maxRecords_example;  // String | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_19 result = apiInstance.describeClusterDbRevisions(apiecoKey, clusterIdentifier, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterDbRevisionsApi.describeClusterDbRevisions: " + 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\DescribeClusterDbRevisionsApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
$marker = marker_example; // String | An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
$maxRecords = maxRecords_example; // String | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

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

# 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::DescribeClusterDbRevisionsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
my $marker = marker_example; # String | An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
my $maxRecords = maxRecords_example; # String | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeClusterDbRevisions(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterDbRevisionsApi->describeClusterDbRevisions: $@\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.DescribeClusterDbRevisionsApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
marker = marker_example # String | An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both. (optional)
maxRecords = maxRecords_example # String | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_cluster_db_revisions(apiecoKey, clusterIdentifier, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterDbRevisionsApi->describeClusterDbRevisions: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
Required
Marker
String
An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
MaxRecords
String
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterParameterGroups

describeClusterParameterGroups

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.


/DescribeClusterParameterGroups

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterParameterGroups?ParameterGroupName=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterParameterGroupsApi;

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

public class DescribeClusterParameterGroupsApiExample {

    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");

        DescribeClusterParameterGroupsApi apiInstance = new DescribeClusterParameterGroupsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        array[String] tagKeys.TagKey.N = ; // array[String] | A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
        array[String] tagValues.TagValue.N = ; // array[String] | A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
        try {
            inline_response_200_20 result = apiInstance.describeClusterParameterGroups(apiecoKey, parameterGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterParameterGroupsApi#describeClusterParameterGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterParameterGroupsApi;

public class DescribeClusterParameterGroupsApiExample {

    public static void main(String[] args) {
        DescribeClusterParameterGroupsApi apiInstance = new DescribeClusterParameterGroupsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        array[String] tagKeys.TagKey.N = ; // array[String] | A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
        array[String] tagValues.TagValue.N = ; // array[String] | A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
        try {
            inline_response_200_20 result = apiInstance.describeClusterParameterGroups(apiecoKey, parameterGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterParameterGroupsApi#describeClusterParameterGroups");
            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 a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
array[String] *tagKeys.TagKey.N = ; // A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them. (optional)
array[String] *tagValues.TagValue.N = ; // A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeClusterParameterGroupsWith:apiecoKey
    parameterGroupName:parameterGroupName
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_20 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_.DescribeClusterParameterGroupsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'parameterGroupName': parameterGroupName_example, // {String} The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': , // {array[String]} A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N':  // {array[String]} A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeClusterParameterGroupsExample
    {
        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 DescribeClusterParameterGroupsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var parameterGroupName = parameterGroupName_example;  // String | The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = new array[String](); // array[String] | A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = new array[String](); // array[String] | A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_20 result = apiInstance.describeClusterParameterGroups(apiecoKey, parameterGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterParameterGroupsApi.describeClusterParameterGroups: " + 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\DescribeClusterParameterGroupsApi();
$apiecoKey = apiecoKey_example; // String | 
$parameterGroupName = parameterGroupName_example; // String | The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = ; // array[String] | A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = ; // array[String] | A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeClusterParameterGroups($apiecoKey, $parameterGroupName, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeClusterParameterGroupsApi->describeClusterParameterGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeClusterParameterGroupsApi;

# 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::DescribeClusterParameterGroupsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $parameterGroupName = parameterGroupName_example; # String | The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = []; # array[String] | A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = []; # array[String] | A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeClusterParameterGroups(apiecoKey => $apiecoKey, parameterGroupName => $parameterGroupName, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterParameterGroupsApi->describeClusterParameterGroups: $@\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.DescribeClusterParameterGroupsApi()
apiecoKey = apiecoKey_example # String | 
parameterGroupName = parameterGroupName_example # String | The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N =  # array[String] | A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N =  # array[String] | A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_cluster_parameter_groups(apiecoKey, parameterGroupName=parameterGroupName, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterParameterGroupsApi->describeClusterParameterGroups: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ParameterGroupName
String
The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
array[String]
A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
TagValues.TagValue.N
array[String]
A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterParameters

describeClusterParameters

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.


/DescribeClusterParameters

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterParameters?ParameterGroupName=&Marker=&MaxRecords=&Source="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterParametersApi;

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

public class DescribeClusterParametersApiExample {

    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");

        DescribeClusterParametersApi apiInstance = new DescribeClusterParametersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of a cluster parameter group for which to return details.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String source = source_example; // String | The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
        try {
            inline_response_200_21 result = apiInstance.describeClusterParameters(apiecoKey, parameterGroupName, marker, maxRecords, source);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterParametersApi#describeClusterParameters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterParametersApi;

public class DescribeClusterParametersApiExample {

    public static void main(String[] args) {
        DescribeClusterParametersApi apiInstance = new DescribeClusterParametersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of a cluster parameter group for which to return details.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String source = source_example; // String | The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
        try {
            inline_response_200_21 result = apiInstance.describeClusterParameters(apiecoKey, parameterGroupName, marker, maxRecords, source);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterParametersApi#describeClusterParameters");
            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 a cluster parameter group for which to return details.
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *source = source_example; // The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default (optional)

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

[apiInstance describeClusterParametersWith:apiecoKey
    parameterGroupName:parameterGroupName
    marker:marker
    maxRecords:maxRecords
    source:source
              completionHandler: ^(inline_response_200_21 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_.DescribeClusterParametersApi()

var apiecoKey = apiecoKey_example; // {String} 

var parameterGroupName = parameterGroupName_example; // {String} The name of a cluster parameter group for which to return details.

var opts = { 
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'source': source_example // {String} The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
};

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

namespace Example
{
    public class describeClusterParametersExample
    {
        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 DescribeClusterParametersApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var parameterGroupName = parameterGroupName_example;  // String | The name of a cluster parameter group for which to return details.
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var source = source_example;  // String | The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default (optional) 

            try
            {
                inline_response_200_21 result = apiInstance.describeClusterParameters(apiecoKey, parameterGroupName, marker, maxRecords, source);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterParametersApi.describeClusterParameters: " + 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\DescribeClusterParametersApi();
$apiecoKey = apiecoKey_example; // String | 
$parameterGroupName = parameterGroupName_example; // String | The name of a cluster parameter group for which to return details.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$source = source_example; // String | The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default

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

# 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::DescribeClusterParametersApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $parameterGroupName = parameterGroupName_example; # String | The name of a cluster parameter group for which to return details.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $source = source_example; # String | The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default

eval { 
    my $result = $api_instance->describeClusterParameters(apiecoKey => $apiecoKey, parameterGroupName => $parameterGroupName, marker => $marker, maxRecords => $maxRecords, source => $source);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterParametersApi->describeClusterParameters: $@\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.DescribeClusterParametersApi()
apiecoKey = apiecoKey_example # String | 
parameterGroupName = parameterGroupName_example # String | The name of a cluster parameter group for which to return details.
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
source = source_example # String | The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default (optional)

try: 
    api_response = api_instance.describe_cluster_parameters(apiecoKey, parameterGroupName, marker=marker, maxRecords=maxRecords, source=source)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterParametersApi->describeClusterParameters: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ParameterGroupName*
String
The name of a cluster parameter group for which to return details.
Required
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
Source
String
The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterSecurityGroups

describeClusterSecurityGroups

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.


/DescribeClusterSecurityGroups

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterSecurityGroups?ClusterSecurityGroupName=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterSecurityGroupsApi;

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

public class DescribeClusterSecurityGroupsApiExample {

    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");

        DescribeClusterSecurityGroupsApi apiInstance = new DescribeClusterSecurityGroupsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_23 result = apiInstance.describeClusterSecurityGroups(apiecoKey, clusterSecurityGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterSecurityGroupsApi#describeClusterSecurityGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterSecurityGroupsApi;

public class DescribeClusterSecurityGroupsApiExample {

    public static void main(String[] args) {
        DescribeClusterSecurityGroupsApi apiInstance = new DescribeClusterSecurityGroupsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_23 result = apiInstance.describeClusterSecurityGroups(apiecoKey, clusterSecurityGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterSecurityGroupsApi#describeClusterSecurityGroups");
            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 a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1 (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeClusterSecurityGroupsWith:apiecoKey
    clusterSecurityGroupName:clusterSecurityGroupName
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_23 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_.DescribeClusterSecurityGroupsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterSecurityGroupName': clusterSecurityGroupName_example, // {String} The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeClusterSecurityGroupsExample
    {
        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 DescribeClusterSecurityGroupsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSecurityGroupName = clusterSecurityGroupName_example;  // String | The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1 (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_23 result = apiInstance.describeClusterSecurityGroups(apiecoKey, clusterSecurityGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterSecurityGroupsApi.describeClusterSecurityGroups: " + 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\DescribeClusterSecurityGroupsApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSecurityGroupName = clusterSecurityGroupName_example; // String | The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeClusterSecurityGroups($apiecoKey, $clusterSecurityGroupName, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeClusterSecurityGroupsApi->describeClusterSecurityGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeClusterSecurityGroupsApi;

# 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::DescribeClusterSecurityGroupsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSecurityGroupName = clusterSecurityGroupName_example; # String | The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeClusterSecurityGroups(apiecoKey => $apiecoKey, clusterSecurityGroupName => $clusterSecurityGroupName, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterSecurityGroupsApi->describeClusterSecurityGroups: $@\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.DescribeClusterSecurityGroupsApi()
apiecoKey = apiecoKey_example # String | 
clusterSecurityGroupName = clusterSecurityGroupName_example # String | The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1 (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_cluster_security_groups(apiecoKey, clusterSecurityGroupName=clusterSecurityGroupName, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterSecurityGroupsApi->describeClusterSecurityGroups: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSecurityGroupName
String
The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. Example: securitygroup1
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterSnapshots

describeClusterSnapshots

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.


/DescribeClusterSnapshots

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterSnapshots?ClusterExists=&Marker=&ClusterIdentifier=&EndTime=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterSnapshotsApi;

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

public class DescribeClusterSnapshotsApiExample {

    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");

        DescribeClusterSnapshotsApi apiInstance = new DescribeClusterSnapshotsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean clusterExists = true; // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster which generated the requested snapshots.
        String endTime = endTime_example; // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_6_snapshot result = apiInstance.describeClusterSnapshots(apiecoKey, clusterExists, marker, clusterIdentifier, endTime, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterSnapshotsApi#describeClusterSnapshots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterSnapshotsApi;

public class DescribeClusterSnapshotsApiExample {

    public static void main(String[] args) {
        DescribeClusterSnapshotsApi apiInstance = new DescribeClusterSnapshotsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean clusterExists = true; // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster which generated the requested snapshots.
        String endTime = endTime_example; // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_6_snapshot result = apiInstance.describeClusterSnapshots(apiecoKey, clusterExists, marker, clusterIdentifier, endTime, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterSnapshotsApi#describeClusterSnapshots");
            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 *clusterExists = true; // A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.          (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
String *clusterIdentifier = clusterIdentifier_example; // The identifier of the cluster which generated the requested snapshots. (optional)
String *endTime = endTime_example; // A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeClusterSnapshotsWith:apiecoKey
    clusterExists:clusterExists
    marker:marker
    clusterIdentifier:clusterIdentifier
    endTime:endTime
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.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_.DescribeClusterSnapshotsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterExists': true, // {Boolean} A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'clusterIdentifier': clusterIdentifier_example, // {String} The identifier of the cluster which generated the requested snapshots.
  'endTime': endTime_example, // {String} A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeClusterSnapshotsExample
    {
        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 DescribeClusterSnapshotsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterExists = true;  // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.          (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster which generated the requested snapshots. (optional) 
            var endTime = endTime_example;  // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_6_snapshot result = apiInstance.describeClusterSnapshots(apiecoKey, clusterExists, marker, clusterIdentifier, endTime, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterSnapshotsApi.describeClusterSnapshots: " + 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\DescribeClusterSnapshotsApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterExists = true; // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster which generated the requested snapshots.
$endTime = endTime_example; // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeClusterSnapshots($apiecoKey, $clusterExists, $marker, $clusterIdentifier, $endTime, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeClusterSnapshotsApi->describeClusterSnapshots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeClusterSnapshotsApi;

# 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::DescribeClusterSnapshotsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterExists = true; # Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster which generated the requested snapshots.
my $endTime = endTime_example; # String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeClusterSnapshots(apiecoKey => $apiecoKey, clusterExists => $clusterExists, marker => $marker, clusterIdentifier => $clusterIdentifier, endTime => $endTime, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterSnapshotsApi->describeClusterSnapshots: $@\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.DescribeClusterSnapshotsApi()
apiecoKey = apiecoKey_example # String | 
clusterExists = true # Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.          (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster which generated the requested snapshots. (optional)
endTime = endTime_example # String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_cluster_snapshots(apiecoKey, clusterExists=clusterExists, marker=marker, clusterIdentifier=clusterIdentifier, endTime=endTime, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterSnapshotsApi->describeClusterSnapshots: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterExists
Boolean
A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned. If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
ClusterIdentifier
String
The identifier of the cluster which generated the requested snapshots.
EndTime
String
A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterSubnetGroups

describeClusterSubnetGroups

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.


/DescribeClusterSubnetGroups

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterSubnetGroups?ClusterSubnetGroupName=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterSubnetGroupsApi;

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

public class DescribeClusterSubnetGroupsApiExample {

    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");

        DescribeClusterSubnetGroupsApi apiInstance = new DescribeClusterSubnetGroupsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the cluster subnet group for which information is requested.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_24 result = apiInstance.describeClusterSubnetGroups(apiecoKey, clusterSubnetGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterSubnetGroupsApi#describeClusterSubnetGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterSubnetGroupsApi;

public class DescribeClusterSubnetGroupsApiExample {

    public static void main(String[] args) {
        DescribeClusterSubnetGroupsApi apiInstance = new DescribeClusterSubnetGroupsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the cluster subnet group for which information is requested.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_24 result = apiInstance.describeClusterSubnetGroups(apiecoKey, clusterSubnetGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterSubnetGroupsApi#describeClusterSubnetGroups");
            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 for which information is requested. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeClusterSubnetGroupsWith:apiecoKey
    clusterSubnetGroupName:clusterSubnetGroupName
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_24 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_.DescribeClusterSubnetGroupsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterSubnetGroupName': clusterSubnetGroupName_example, // {String} The name of the cluster subnet group for which information is requested.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeClusterSubnetGroupsExample
    {
        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 DescribeClusterSubnetGroupsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSubnetGroupName = clusterSubnetGroupName_example;  // String | The name of the cluster subnet group for which information is requested. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_24 result = apiInstance.describeClusterSubnetGroups(apiecoKey, clusterSubnetGroupName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterSubnetGroupsApi.describeClusterSubnetGroups: " + 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\DescribeClusterSubnetGroupsApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the cluster subnet group for which information is requested.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeClusterSubnetGroups($apiecoKey, $clusterSubnetGroupName, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeClusterSubnetGroupsApi->describeClusterSubnetGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeClusterSubnetGroupsApi;

# 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::DescribeClusterSubnetGroupsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSubnetGroupName = clusterSubnetGroupName_example; # String | The name of the cluster subnet group for which information is requested.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeClusterSubnetGroups(apiecoKey => $apiecoKey, clusterSubnetGroupName => $clusterSubnetGroupName, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterSubnetGroupsApi->describeClusterSubnetGroups: $@\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.DescribeClusterSubnetGroupsApi()
apiecoKey = apiecoKey_example # String | 
clusterSubnetGroupName = clusterSubnetGroupName_example # String | The name of the cluster subnet group for which information is requested. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_cluster_subnet_groups(apiecoKey, clusterSubnetGroupName=clusterSubnetGroupName, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterSubnetGroupsApi->describeClusterSubnetGroups: %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 for which information is requested.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterTracks

describeClusterTracks

Returns a list of all the available maintenance tracks.


/DescribeClusterTracks

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterTracks?MaintenanceTrackName=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterTracksApi;

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

public class DescribeClusterTracksApiExample {

    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");

        DescribeClusterTracksApi apiInstance = new DescribeClusterTracksApi();
        String apiecoKey = apiecoKey_example; // String | 
        String maintenanceTrackName = maintenanceTrackName_example; // String | MaintenanceTrackName
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_25 result = apiInstance.describeClusterTracks(apiecoKey, maintenanceTrackName, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterTracksApi#describeClusterTracks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterTracksApi;

public class DescribeClusterTracksApiExample {

    public static void main(String[] args) {
        DescribeClusterTracksApi apiInstance = new DescribeClusterTracksApi();
        String apiecoKey = apiecoKey_example; // String | 
        String maintenanceTrackName = maintenanceTrackName_example; // String | MaintenanceTrackName
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_25 result = apiInstance.describeClusterTracks(apiecoKey, maintenanceTrackName, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterTracksApi#describeClusterTracks");
            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 *maintenanceTrackName = maintenanceTrackName_example; // MaintenanceTrackName (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeClusterTracksWith:apiecoKey
    maintenanceTrackName:maintenanceTrackName
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_25 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_.DescribeClusterTracksApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'maintenanceTrackName': maintenanceTrackName_example, // {String} MaintenanceTrackName
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeClusterTracksExample
    {
        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 DescribeClusterTracksApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var maintenanceTrackName = maintenanceTrackName_example;  // String | MaintenanceTrackName (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_25 result = apiInstance.describeClusterTracks(apiecoKey, maintenanceTrackName, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterTracksApi.describeClusterTracks: " + 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\DescribeClusterTracksApi();
$apiecoKey = apiecoKey_example; // String | 
$maintenanceTrackName = maintenanceTrackName_example; // String | MaintenanceTrackName
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

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

# 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::DescribeClusterTracksApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $maintenanceTrackName = maintenanceTrackName_example; # String | MaintenanceTrackName
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeClusterTracks(apiecoKey => $apiecoKey, maintenanceTrackName => $maintenanceTrackName, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterTracksApi->describeClusterTracks: $@\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.DescribeClusterTracksApi()
apiecoKey = apiecoKey_example # String | 
maintenanceTrackName = maintenanceTrackName_example # String | MaintenanceTrackName (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_cluster_tracks(apiecoKey, maintenanceTrackName=maintenanceTrackName, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterTracksApi->describeClusterTracks: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
MaintenanceTrackName
String
MaintenanceTrackName
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusterVersions

describeClusterVersions

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions.


/DescribeClusterVersions

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusterVersions?ClusterParameterGroupFamily=&ClusterVersion=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClusterVersionsApi;

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

public class DescribeClusterVersionsApiExample {

    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");

        DescribeClusterVersionsApi apiInstance = new DescribeClusterVersionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterParameterGroupFamily = clusterParameterGroupFamily_example; // String | The name of a specific cluster parameter group family to return details for.
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 clusterVersion = clusterVersion_example; // String | The specific cluster version to return.
Example: 1.0
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_26 result = apiInstance.describeClusterVersions(apiecoKey, clusterParameterGroupFamily, clusterVersion, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterVersionsApi#describeClusterVersions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClusterVersionsApi;

public class DescribeClusterVersionsApiExample {

    public static void main(String[] args) {
        DescribeClusterVersionsApi apiInstance = new DescribeClusterVersionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterParameterGroupFamily = clusterParameterGroupFamily_example; // String | The name of a specific cluster parameter group family to return details for.
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 clusterVersion = clusterVersion_example; // String | The specific cluster version to return.
Example: 1.0
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_26 result = apiInstance.describeClusterVersions(apiecoKey, clusterParameterGroupFamily, clusterVersion, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClusterVersionsApi#describeClusterVersions");
            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 *clusterParameterGroupFamily = clusterParameterGroupFamily_example; // The name of a specific cluster parameter group family to return details for.
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 *clusterVersion = clusterVersion_example; // The specific cluster version to return.
Example: 1.0 (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeClusterVersionsWith:apiecoKey
    clusterParameterGroupFamily:clusterParameterGroupFamily
    clusterVersion:clusterVersion
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_26 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_.DescribeClusterVersionsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterParameterGroupFamily': clusterParameterGroupFamily_example, // {String} The name of a specific cluster parameter group family to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
  'clusterVersion': clusterVersion_example, // {String} The specific cluster version to return.
Example: 1.0
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeClusterVersionsExample
    {
        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 DescribeClusterVersionsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterParameterGroupFamily = clusterParameterGroupFamily_example;  // String | The name of a specific cluster parameter group family to return details for.
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 clusterVersion = clusterVersion_example;  // String | The specific cluster version to return.
Example: 1.0 (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_26 result = apiInstance.describeClusterVersions(apiecoKey, clusterParameterGroupFamily, clusterVersion, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClusterVersionsApi.describeClusterVersions: " + 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\DescribeClusterVersionsApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterParameterGroupFamily = clusterParameterGroupFamily_example; // String | The name of a specific cluster parameter group family to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
$clusterVersion = clusterVersion_example; // String | The specific cluster version to return.
Example: 1.0
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

try {
    $result = $api_instance->describeClusterVersions($apiecoKey, $clusterParameterGroupFamily, $clusterVersion, $marker, $maxRecords);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeClusterVersionsApi->describeClusterVersions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeClusterVersionsApi;

# 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::DescribeClusterVersionsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterParameterGroupFamily = clusterParameterGroupFamily_example; # String | The name of a specific cluster parameter group family to return details for.
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 $clusterVersion = clusterVersion_example; # String | The specific cluster version to return.
Example: 1.0
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeClusterVersions(apiecoKey => $apiecoKey, clusterParameterGroupFamily => $clusterParameterGroupFamily, clusterVersion => $clusterVersion, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClusterVersionsApi->describeClusterVersions: $@\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.DescribeClusterVersionsApi()
apiecoKey = apiecoKey_example # String | 
clusterParameterGroupFamily = clusterParameterGroupFamily_example # String | The name of a specific cluster parameter group family to return details for.
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)
clusterVersion = clusterVersion_example # String | The specific cluster version to return.
Example: 1.0 (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_cluster_versions(apiecoKey, clusterParameterGroupFamily=clusterParameterGroupFamily, clusterVersion=clusterVersion, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClusterVersionsApi->describeClusterVersions: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterParameterGroupFamily
String
The name of a specific cluster parameter group family to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
ClusterVersion
String
The specific cluster version to return. Example: 1.0
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeClusters

describeClusters

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.


/DescribeClusters

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeClusters?ClusterIdentifier=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeClustersApi;

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

public class DescribeClustersApiExample {

    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");

        DescribeClustersApi apiInstance = new DescribeClustersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_22 result = apiInstance.describeClusters(apiecoKey, clusterIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClustersApi#describeClusters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeClustersApi;

public class DescribeClustersApiExample {

    public static void main(String[] args) {
        DescribeClustersApi apiInstance = new DescribeClustersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_22 result = apiInstance.describeClusters(apiecoKey, clusterIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeClustersApi#describeClusters");
            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 of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeClustersWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_22 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_.DescribeClustersApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterIdentifier': clusterIdentifier_example, // {String} The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeClustersExample
    {
        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 DescribeClustersApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_22 result = apiInstance.describeClusters(apiecoKey, clusterIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeClustersApi.describeClusters: " + 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\DescribeClustersApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeClusters($apiecoKey, $clusterIdentifier, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeClustersApi->describeClusters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeClustersApi;

# 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::DescribeClustersApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeClusters(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeClustersApi->describeClusters: $@\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.DescribeClustersApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_clusters(apiecoKey, clusterIdentifier=clusterIdentifier, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeClustersApi->describeClusters: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
String
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeDefaultClusterParameters

describeDefaultClusterParameters

Returns a list of parameter settings for the specified parameter group family.


/DescribeDefaultClusterParameters

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeDefaultClusterParameters?ParameterGroupFamily=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeDefaultClusterParametersApi;

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

public class DescribeDefaultClusterParametersApiExample {

    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");

        DescribeDefaultClusterParametersApi apiInstance = new DescribeDefaultClusterParametersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupFamily = parameterGroupFamily_example; // String | The name of the cluster parameter group family.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_27 result = apiInstance.describeDefaultClusterParameters(apiecoKey, parameterGroupFamily, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeDefaultClusterParametersApi#describeDefaultClusterParameters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeDefaultClusterParametersApi;

public class DescribeDefaultClusterParametersApiExample {

    public static void main(String[] args) {
        DescribeDefaultClusterParametersApi apiInstance = new DescribeDefaultClusterParametersApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupFamily = parameterGroupFamily_example; // String | The name of the cluster parameter group family.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_27 result = apiInstance.describeDefaultClusterParameters(apiecoKey, parameterGroupFamily, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeDefaultClusterParametersApi#describeDefaultClusterParameters");
            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 *parameterGroupFamily = parameterGroupFamily_example; // The name of the cluster parameter group family. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeDefaultClusterParametersWith:apiecoKey
    parameterGroupFamily:parameterGroupFamily
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_27 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_.DescribeDefaultClusterParametersApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'parameterGroupFamily': parameterGroupFamily_example, // {String} The name of the cluster parameter group family.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeDefaultClusterParametersExample
    {
        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 DescribeDefaultClusterParametersApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var parameterGroupFamily = parameterGroupFamily_example;  // String | The name of the cluster parameter group family. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_27 result = apiInstance.describeDefaultClusterParameters(apiecoKey, parameterGroupFamily, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeDefaultClusterParametersApi.describeDefaultClusterParameters: " + 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\DescribeDefaultClusterParametersApi();
$apiecoKey = apiecoKey_example; // String | 
$parameterGroupFamily = parameterGroupFamily_example; // String | The name of the cluster parameter group family.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

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

# 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::DescribeDefaultClusterParametersApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $parameterGroupFamily = parameterGroupFamily_example; # String | The name of the cluster parameter group family.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeDefaultClusterParameters(apiecoKey => $apiecoKey, parameterGroupFamily => $parameterGroupFamily, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeDefaultClusterParametersApi->describeDefaultClusterParameters: $@\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.DescribeDefaultClusterParametersApi()
apiecoKey = apiecoKey_example # String | 
parameterGroupFamily = parameterGroupFamily_example # String | The name of the cluster parameter group family. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_default_cluster_parameters(apiecoKey, parameterGroupFamily=parameterGroupFamily, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeDefaultClusterParametersApi->describeDefaultClusterParameters: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ParameterGroupFamily
String
The name of the cluster parameter group family.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeEventCategories

describeEventCategories

Displays a list of event categories for all event source types, or for a specified source type


/DescribeEventCategories

Usage and SDK Samples

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

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

public class DescribeEventCategoriesApiExample {

    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");

        DescribeEventCategoriesApi apiInstance = new DescribeEventCategoriesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String sourceType = sourceType_example; // String | The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action.
        try {
            inline_response_200_28 result = apiInstance.describeEventCategories(apiecoKey, sourceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeEventCategoriesApi#describeEventCategories");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeEventCategoriesApi;

public class DescribeEventCategoriesApiExample {

    public static void main(String[] args) {
        DescribeEventCategoriesApi apiInstance = new DescribeEventCategoriesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String sourceType = sourceType_example; // String | The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action.
        try {
            inline_response_200_28 result = apiInstance.describeEventCategories(apiecoKey, sourceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeEventCategoriesApi#describeEventCategories");
            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 *sourceType = sourceType_example; // The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action. (optional)

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

[apiInstance describeEventCategoriesWith:apiecoKey
    sourceType:sourceType
              completionHandler: ^(inline_response_200_28 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_.DescribeEventCategoriesApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'sourceType': sourceType_example // {String} The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action.
};

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

namespace Example
{
    public class describeEventCategoriesExample
    {
        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 DescribeEventCategoriesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var sourceType = sourceType_example;  // String | The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action. (optional) 

            try
            {
                inline_response_200_28 result = apiInstance.describeEventCategories(apiecoKey, sourceType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeEventCategoriesApi.describeEventCategories: " + 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\DescribeEventCategoriesApi();
$apiecoKey = apiecoKey_example; // String | 
$sourceType = sourceType_example; // String | The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action.

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

# 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::DescribeEventCategoriesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $sourceType = sourceType_example; # String | The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action.

eval { 
    my $result = $api_instance->describeEventCategories(apiecoKey => $apiecoKey, sourceType => $sourceType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeEventCategoriesApi->describeEventCategories: $@\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.DescribeEventCategoriesApi()
apiecoKey = apiecoKey_example # String | 
sourceType = sourceType_example # String | The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster           -security-group, and scheduled-action. (optional)

try: 
    api_response = api_instance.describe_event_categories(apiecoKey, sourceType=sourceType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeEventCategoriesApi->describeEventCategories: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
SourceType
String
The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster -security-group, and scheduled-action.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeEventSubscriptions

describeEventSubscriptions

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.


/DescribeEventSubscriptions

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeEventSubscriptions?SubscriptionName=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeEventSubscriptionsApi;

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

public class DescribeEventSubscriptionsApiExample {

    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");

        DescribeEventSubscriptionsApi apiInstance = new DescribeEventSubscriptionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String subscriptionName = subscriptionName_example; // String | The name of the Amazon Redshift event notification subscription to be described.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_30 result = apiInstance.describeEventSubscriptions(apiecoKey, subscriptionName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeEventSubscriptionsApi#describeEventSubscriptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeEventSubscriptionsApi;

public class DescribeEventSubscriptionsApiExample {

    public static void main(String[] args) {
        DescribeEventSubscriptionsApi apiInstance = new DescribeEventSubscriptionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String subscriptionName = subscriptionName_example; // String | The name of the Amazon Redshift event notification subscription to be described.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_30 result = apiInstance.describeEventSubscriptions(apiecoKey, subscriptionName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeEventSubscriptionsApi#describeEventSubscriptions");
            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 described. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeEventSubscriptionsWith:apiecoKey
    subscriptionName:subscriptionName
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_30 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_.DescribeEventSubscriptionsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'subscriptionName': subscriptionName_example, // {String} The name of the Amazon Redshift event notification subscription to be described.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeEventSubscriptionsExample
    {
        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 DescribeEventSubscriptionsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var subscriptionName = subscriptionName_example;  // String | The name of the Amazon Redshift event notification subscription to be described. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_30 result = apiInstance.describeEventSubscriptions(apiecoKey, subscriptionName, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeEventSubscriptionsApi.describeEventSubscriptions: " + 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\DescribeEventSubscriptionsApi();
$apiecoKey = apiecoKey_example; // String | 
$subscriptionName = subscriptionName_example; // String | The name of the Amazon Redshift event notification subscription to be described.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeEventSubscriptions($apiecoKey, $subscriptionName, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeEventSubscriptionsApi->describeEventSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeEventSubscriptionsApi;

# 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::DescribeEventSubscriptionsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $subscriptionName = subscriptionName_example; # String | The name of the Amazon Redshift event notification subscription to be described.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeEventSubscriptions(apiecoKey => $apiecoKey, subscriptionName => $subscriptionName, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeEventSubscriptionsApi->describeEventSubscriptions: $@\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.DescribeEventSubscriptionsApi()
apiecoKey = apiecoKey_example # String | 
subscriptionName = subscriptionName_example # String | The name of the Amazon Redshift event notification subscription to be described. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_event_subscriptions(apiecoKey, subscriptionName=subscriptionName, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeEventSubscriptionsApi->describeEventSubscriptions: %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 described.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeEvents

describeEvents

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.


/DescribeEvents

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeEvents?Duration=&Marker=&MaxRecords=&EndTime=&SourceIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeEventsApi;

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

public class DescribeEventsApiExample {

    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");

        DescribeEventsApi apiInstance = new DescribeEventsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer duration = 56; // Integer | The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String endTime = endTime_example; // String | The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
        String sourceIdentifier = sourceIdentifier_example; // String | The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
        try {
            inline_response_200_29 result = apiInstance.describeEvents(apiecoKey, duration, marker, maxRecords, endTime, sourceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeEventsApi#describeEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeEventsApi;

public class DescribeEventsApiExample {

    public static void main(String[] args) {
        DescribeEventsApi apiInstance = new DescribeEventsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer duration = 56; // Integer | The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String endTime = endTime_example; // String | The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
        String sourceIdentifier = sourceIdentifier_example; // String | The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
        try {
            inline_response_200_29 result = apiInstance.describeEvents(apiecoKey, duration, marker, maxRecords, endTime, sourceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeEventsApi#describeEvents");
            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; // 
Integer *duration = 56; // The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60 (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *endTime = endTime_example; // The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z (optional)
String *sourceIdentifier = sourceIdentifier_example; // The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot. (optional)

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

[apiInstance describeEventsWith:apiecoKey
    duration:duration
    marker:marker
    maxRecords:maxRecords
    endTime:endTime
    sourceIdentifier:sourceIdentifier
              completionHandler: ^(inline_response_200_29 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_.DescribeEventsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'duration': 56, // {Integer} The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'endTime': endTime_example, // {String} The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
  'sourceIdentifier': sourceIdentifier_example // {String} The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
};

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

namespace Example
{
    public class describeEventsExample
    {
        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 DescribeEventsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var duration = 56;  // Integer | The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60 (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var endTime = endTime_example;  // String | The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z (optional) 
            var sourceIdentifier = sourceIdentifier_example;  // String | The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot. (optional) 

            try
            {
                inline_response_200_29 result = apiInstance.describeEvents(apiecoKey, duration, marker, maxRecords, endTime, sourceIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeEventsApi.describeEvents: " + 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\DescribeEventsApi();
$apiecoKey = apiecoKey_example; // String | 
$duration = 56; // Integer | The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$endTime = endTime_example; // String | The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
$sourceIdentifier = sourceIdentifier_example; // String | The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

try {
    $result = $api_instance->describeEvents($apiecoKey, $duration, $marker, $maxRecords, $endTime, $sourceIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeEventsApi->describeEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeEventsApi;

# 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::DescribeEventsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $duration = 56; # Integer | The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $endTime = endTime_example; # String | The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
my $sourceIdentifier = sourceIdentifier_example; # String | The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

eval { 
    my $result = $api_instance->describeEvents(apiecoKey => $apiecoKey, duration => $duration, marker => $marker, maxRecords => $maxRecords, endTime => $endTime, sourceIdentifier => $sourceIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeEventsApi->describeEvents: $@\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.DescribeEventsApi()
apiecoKey = apiecoKey_example # String | 
duration = 56 # Integer | The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60 (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
endTime = endTime_example # String | The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z (optional)
sourceIdentifier = sourceIdentifier_example # String | The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot. (optional)

try: 
    api_response = api_instance.describe_events(apiecoKey, duration=duration, marker=marker, maxRecords=maxRecords, endTime=endTime, sourceIdentifier=sourceIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeEventsApi->describeEvents: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
Duration
Integer
The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: 60
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
EndTime
String
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
SourceIdentifier
String
The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. Specify a cluster identifier when SourceType is cluster. Specify a cluster security group name when SourceType is cluster-security-group. Specify a cluster parameter group name when SourceType is cluster-parameter-group. Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeHsmClientCertificates

describeHsmClientCertificates

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.


/DescribeHsmClientCertificates

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeHsmClientCertificates?HsmClientCertificateIdentifier=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeHsmClientCertificatesApi;

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

public class DescribeHsmClientCertificatesApiExample {

    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");

        DescribeHsmClientCertificatesApi apiInstance = new DescribeHsmClientCertificatesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account..
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_31 result = apiInstance.describeHsmClientCertificates(apiecoKey, hsmClientCertificateIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeHsmClientCertificatesApi#describeHsmClientCertificates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeHsmClientCertificatesApi;

public class DescribeHsmClientCertificatesApiExample {

    public static void main(String[] args) {
        DescribeHsmClientCertificatesApi apiInstance = new DescribeHsmClientCertificatesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account..
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_31 result = apiInstance.describeHsmClientCertificates(apiecoKey, hsmClientCertificateIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeHsmClientCertificatesApi#describeHsmClientCertificates");
            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 a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeHsmClientCertificatesWith:apiecoKey
    hsmClientCertificateIdentifier:hsmClientCertificateIdentifier
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_31 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_.DescribeHsmClientCertificatesApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'hsmClientCertificateIdentifier': hsmClientCertificateIdentifier_example, // {String} The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account..
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeHsmClientCertificatesExample
    {
        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 DescribeHsmClientCertificatesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example;  // String | The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_31 result = apiInstance.describeHsmClientCertificates(apiecoKey, hsmClientCertificateIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeHsmClientCertificatesApi.describeHsmClientCertificates: " + 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\DescribeHsmClientCertificatesApi();
$apiecoKey = apiecoKey_example; // String | 
$hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; // String | The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account..
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeHsmClientCertificates($apiecoKey, $hsmClientCertificateIdentifier, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeHsmClientCertificatesApi->describeHsmClientCertificates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeHsmClientCertificatesApi;

# 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::DescribeHsmClientCertificatesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example; # String | The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account..
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeHsmClientCertificates(apiecoKey => $apiecoKey, hsmClientCertificateIdentifier => $hsmClientCertificateIdentifier, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeHsmClientCertificatesApi->describeHsmClientCertificates: $@\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.DescribeHsmClientCertificatesApi()
apiecoKey = apiecoKey_example # String | 
hsmClientCertificateIdentifier = hsmClientCertificateIdentifier_example # String | The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_hsm_client_certificates(apiecoKey, hsmClientCertificateIdentifier=hsmClientCertificateIdentifier, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeHsmClientCertificatesApi->describeHsmClientCertificates: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
HsmClientCertificateIdentifier
String
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account..
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeHsmConfigurations

describeHsmConfigurations

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.


/DescribeHsmConfigurations

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeHsmConfigurations?HsmConfigurationIdentifier=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeHsmConfigurationsApi;

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

public class DescribeHsmConfigurationsApiExample {

    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");

        DescribeHsmConfigurationsApi apiInstance = new DescribeHsmConfigurationsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_32 result = apiInstance.describeHsmConfigurations(apiecoKey, hsmConfigurationIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeHsmConfigurationsApi#describeHsmConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeHsmConfigurationsApi;

public class DescribeHsmConfigurationsApiExample {

    public static void main(String[] args) {
        DescribeHsmConfigurationsApi apiInstance = new DescribeHsmConfigurationsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_32 result = apiInstance.describeHsmConfigurations(apiecoKey, hsmConfigurationIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeHsmConfigurationsApi#describeHsmConfigurations");
            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 *hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeHsmConfigurationsWith:apiecoKey
    hsmConfigurationIdentifier:hsmConfigurationIdentifier
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_32 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_.DescribeHsmConfigurationsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'hsmConfigurationIdentifier': hsmConfigurationIdentifier_example, // {String} The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeHsmConfigurationsExample
    {
        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 DescribeHsmConfigurationsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var hsmConfigurationIdentifier = hsmConfigurationIdentifier_example;  // String | The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_32 result = apiInstance.describeHsmConfigurations(apiecoKey, hsmConfigurationIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeHsmConfigurationsApi.describeHsmConfigurations: " + 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\DescribeHsmConfigurationsApi();
$apiecoKey = apiecoKey_example; // String | 
$hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; // String | The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeHsmConfigurations($apiecoKey, $hsmConfigurationIdentifier, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeHsmConfigurationsApi->describeHsmConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeHsmConfigurationsApi;

# 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::DescribeHsmConfigurationsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $hsmConfigurationIdentifier = hsmConfigurationIdentifier_example; # String | The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeHsmConfigurations(apiecoKey => $apiecoKey, hsmConfigurationIdentifier => $hsmConfigurationIdentifier, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeHsmConfigurationsApi->describeHsmConfigurations: $@\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.DescribeHsmConfigurationsApi()
apiecoKey = apiecoKey_example # String | 
hsmConfigurationIdentifier = hsmConfigurationIdentifier_example # String | The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_hsm_configurations(apiecoKey, hsmConfigurationIdentifier=hsmConfigurationIdentifier, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeHsmConfigurationsApi->describeHsmConfigurations: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
HsmConfigurationIdentifier
String
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeLoggingStatus

describeLoggingStatus

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.


/DescribeLoggingStatus

Usage and SDK Samples

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

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

public class DescribeLoggingStatusApiExample {

    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");

        DescribeLoggingStatusApi apiInstance = new DescribeLoggingStatusApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster from which to get the logging status.
Example: examplecluster
        try {
            inline_response_200_33 result = apiInstance.describeLoggingStatus(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeLoggingStatusApi#describeLoggingStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeLoggingStatusApi;

public class DescribeLoggingStatusApiExample {

    public static void main(String[] args) {
        DescribeLoggingStatusApi apiInstance = new DescribeLoggingStatusApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster from which to get the logging status.
Example: examplecluster
        try {
            inline_response_200_33 result = apiInstance.describeLoggingStatus(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeLoggingStatusApi#describeLoggingStatus");
            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 from which to get the logging status.
Example: examplecluster

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

[apiInstance describeLoggingStatusWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_33 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_.DescribeLoggingStatusApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The identifier of the cluster from which to get the logging status.
Example: examplecluster


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

namespace Example
{
    public class describeLoggingStatusExample
    {
        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 DescribeLoggingStatusApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster from which to get the logging status.
Example: examplecluster

            try
            {
                inline_response_200_33 result = apiInstance.describeLoggingStatus(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeLoggingStatusApi.describeLoggingStatus: " + 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\DescribeLoggingStatusApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster from which to get the logging status.
Example: examplecluster

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

# 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::DescribeLoggingStatusApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster from which to get the logging status.
Example: examplecluster

eval { 
    my $result = $api_instance->describeLoggingStatus(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeLoggingStatusApi->describeLoggingStatus: $@\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.DescribeLoggingStatusApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster from which to get the logging status.
Example: examplecluster

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The identifier of the cluster from which to get the logging status. Example: examplecluster
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeNodeConfigurationOptions

describeNodeConfigurationOptions

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.


/DescribeNodeConfigurationOptions

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeNodeConfigurationOptions?ActionType=&Marker=&MaxRecords=&ClusterIdentifier=&Filter.NodeConfigurationOptionsFilter.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeNodeConfigurationOptionsApi;

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

public class DescribeNodeConfigurationOptionsApiExample {

    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");

        DescribeNodeConfigurationOptionsApi apiInstance = new DescribeNodeConfigurationOptionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String actionType = actionType_example; // String | The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to evaluate for possible node configurations.
        array[String] filter.NodeConfigurationOptionsFilter.N = ; // array[String] | A set of name, operator, and value items to filter the results.
        try {
            inline_response_200_34 result = apiInstance.describeNodeConfigurationOptions(apiecoKey, actionType, marker, maxRecords, clusterIdentifier, filter.NodeConfigurationOptionsFilter.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeNodeConfigurationOptionsApi#describeNodeConfigurationOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeNodeConfigurationOptionsApi;

public class DescribeNodeConfigurationOptionsApiExample {

    public static void main(String[] args) {
        DescribeNodeConfigurationOptionsApi apiInstance = new DescribeNodeConfigurationOptionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String actionType = actionType_example; // String | The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to evaluate for possible node configurations.
        array[String] filter.NodeConfigurationOptionsFilter.N = ; // array[String] | A set of name, operator, and value items to filter the results.
        try {
            inline_response_200_34 result = apiInstance.describeNodeConfigurationOptions(apiecoKey, actionType, marker, maxRecords, clusterIdentifier, filter.NodeConfigurationOptionsFilter.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeNodeConfigurationOptionsApi#describeNodeConfigurationOptions");
            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 *actionType = actionType_example; // The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *clusterIdentifier = clusterIdentifier_example; // The identifier of the cluster to evaluate for possible node configurations. (optional)
array[String] *filter.NodeConfigurationOptionsFilter.N = ; // A set of name, operator, and value items to filter the results. (optional)

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

[apiInstance describeNodeConfigurationOptionsWith:apiecoKey
    actionType:actionType
    marker:marker
    maxRecords:maxRecords
    clusterIdentifier:clusterIdentifier
    filter.NodeConfigurationOptionsFilter.N:filter.NodeConfigurationOptionsFilter.N
              completionHandler: ^(inline_response_200_34 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_.DescribeNodeConfigurationOptionsApi()

var apiecoKey = apiecoKey_example; // {String} 

var actionType = actionType_example; // {String} The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster

var opts = { 
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'clusterIdentifier': clusterIdentifier_example, // {String} The identifier of the cluster to evaluate for possible node configurations.
  'filter.NodeConfigurationOptionsFilter.N':  // {array[String]} A set of name, operator, and value items to filter the results.
};

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

namespace Example
{
    public class describeNodeConfigurationOptionsExample
    {
        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 DescribeNodeConfigurationOptionsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var actionType = actionType_example;  // String | The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster to evaluate for possible node configurations. (optional) 
            var filter.NodeConfigurationOptionsFilter.N = new array[String](); // array[String] | A set of name, operator, and value items to filter the results. (optional) 

            try
            {
                inline_response_200_34 result = apiInstance.describeNodeConfigurationOptions(apiecoKey, actionType, marker, maxRecords, clusterIdentifier, filter.NodeConfigurationOptionsFilter.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeNodeConfigurationOptionsApi.describeNodeConfigurationOptions: " + 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\DescribeNodeConfigurationOptionsApi();
$apiecoKey = apiecoKey_example; // String | 
$actionType = actionType_example; // String | The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to evaluate for possible node configurations.
$filter.NodeConfigurationOptionsFilter.N = ; // array[String] | A set of name, operator, and value items to filter the results.

try {
    $result = $api_instance->describeNodeConfigurationOptions($apiecoKey, $actionType, $marker, $maxRecords, $clusterIdentifier, $filter.NodeConfigurationOptionsFilter.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeNodeConfigurationOptionsApi->describeNodeConfigurationOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeNodeConfigurationOptionsApi;

# 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::DescribeNodeConfigurationOptionsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $actionType = actionType_example; # String | The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster to evaluate for possible node configurations.
my $filter.NodeConfigurationOptionsFilter.N = []; # array[String] | A set of name, operator, and value items to filter the results.

eval { 
    my $result = $api_instance->describeNodeConfigurationOptions(apiecoKey => $apiecoKey, actionType => $actionType, marker => $marker, maxRecords => $maxRecords, clusterIdentifier => $clusterIdentifier, filter.NodeConfigurationOptionsFilter.N => $filter.NodeConfigurationOptionsFilter.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeNodeConfigurationOptionsApi->describeNodeConfigurationOptions: $@\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.DescribeNodeConfigurationOptionsApi()
apiecoKey = apiecoKey_example # String | 
actionType = actionType_example # String | The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
Type: String
Valid Values: restore-cluster | recommend-node-config | resize-cluster
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster to evaluate for possible node configurations. (optional)
filter.NodeConfigurationOptionsFilter.N =  # array[String] | A set of name, operator, and value items to filter the results. (optional)

try: 
    api_response = api_instance.describe_node_configuration_options(apiecoKey, actionType, marker=marker, maxRecords=maxRecords, clusterIdentifier=clusterIdentifier, filter.NodeConfigurationOptionsFilter.N=filter.NodeConfigurationOptionsFilter.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeNodeConfigurationOptionsApi->describeNodeConfigurationOptions: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ActionType*
String
The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster. Type: String Valid Values: restore-cluster | recommend-node-config | resize-cluster
Required
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
ClusterIdentifier
String
The identifier of the cluster to evaluate for possible node configurations.
Filter.NodeConfigurationOptionsFilter.N
array[String]
A set of name, operator, and value items to filter the results.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeOrderableClusterOptions

describeOrderableClusterOptions

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster


/DescribeOrderableClusterOptions

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeOrderableClusterOptions?ClusterVersion=&Marker=&MaxRecords=&NodeType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeOrderableClusterOptionsApi;

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

public class DescribeOrderableClusterOptionsApiExample {

    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");

        DescribeOrderableClusterOptionsApi apiInstance = new DescribeOrderableClusterOptionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterVersion = clusterVersion_example; // String | The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             .
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String nodeType = nodeType_example; // String | The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
        try {
            inline_response_200_35 result = apiInstance.describeOrderableClusterOptions(apiecoKey, clusterVersion, marker, maxRecords, nodeType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeOrderableClusterOptionsApi#describeOrderableClusterOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeOrderableClusterOptionsApi;

public class DescribeOrderableClusterOptionsApiExample {

    public static void main(String[] args) {
        DescribeOrderableClusterOptionsApi apiInstance = new DescribeOrderableClusterOptionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterVersion = clusterVersion_example; // String | The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             .
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String nodeType = nodeType_example; // String | The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
        try {
            inline_response_200_35 result = apiInstance.describeOrderableClusterOptions(apiecoKey, clusterVersion, marker, maxRecords, nodeType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeOrderableClusterOptionsApi#describeOrderableClusterOptions");
            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 *clusterVersion = clusterVersion_example; // The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             . (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *nodeType = nodeType_example; // The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. (optional)

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

[apiInstance describeOrderableClusterOptionsWith:apiecoKey
    clusterVersion:clusterVersion
    marker:marker
    maxRecords:maxRecords
    nodeType:nodeType
              completionHandler: ^(inline_response_200_35 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_.DescribeOrderableClusterOptionsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterVersion': clusterVersion_example, // {String} The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             .
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'nodeType': nodeType_example // {String} The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
};

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

namespace Example
{
    public class describeOrderableClusterOptionsExample
    {
        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 DescribeOrderableClusterOptionsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterVersion = clusterVersion_example;  // String | The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             . (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var nodeType = nodeType_example;  // String | The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. (optional) 

            try
            {
                inline_response_200_35 result = apiInstance.describeOrderableClusterOptions(apiecoKey, clusterVersion, marker, maxRecords, nodeType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeOrderableClusterOptionsApi.describeOrderableClusterOptions: " + 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\DescribeOrderableClusterOptionsApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterVersion = clusterVersion_example; // String | The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             .
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$nodeType = nodeType_example; // String | The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

try {
    $result = $api_instance->describeOrderableClusterOptions($apiecoKey, $clusterVersion, $marker, $maxRecords, $nodeType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeOrderableClusterOptionsApi->describeOrderableClusterOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeOrderableClusterOptionsApi;

# 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::DescribeOrderableClusterOptionsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterVersion = clusterVersion_example; # String | The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             .
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $nodeType = nodeType_example; # String | The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

eval { 
    my $result = $api_instance->describeOrderableClusterOptions(apiecoKey => $apiecoKey, clusterVersion => $clusterVersion, marker => $marker, maxRecords => $maxRecords, nodeType => $nodeType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeOrderableClusterOptionsApi->describeOrderableClusterOptions: $@\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.DescribeOrderableClusterOptionsApi()
apiecoKey = apiecoKey_example # String | 
clusterVersion = clusterVersion_example # String | The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions             . (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
nodeType = nodeType_example # String | The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. (optional)

try: 
    api_response = api_instance.describe_orderable_cluster_options(apiecoKey, clusterVersion=clusterVersion, marker=marker, maxRecords=maxRecords, nodeType=nodeType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeOrderableClusterOptionsApi->describeOrderableClusterOptions: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterVersion
String
The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions .
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
NodeType
String
The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeReservedNodeOfferings

describeReservedNodeOfferings

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.


/DescribeReservedNodeOfferings

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeReservedNodeOfferings?ReservedNodeOfferingId=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeReservedNodeOfferingsApi;

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

public class DescribeReservedNodeOfferingsApiExample {

    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");

        DescribeReservedNodeOfferingsApi apiInstance = new DescribeReservedNodeOfferingsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeOfferingId = reservedNodeOfferingId_example; // String | The unique identifier for the offering.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_36 result = apiInstance.describeReservedNodeOfferings(apiecoKey, reservedNodeOfferingId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeReservedNodeOfferingsApi#describeReservedNodeOfferings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeReservedNodeOfferingsApi;

public class DescribeReservedNodeOfferingsApiExample {

    public static void main(String[] args) {
        DescribeReservedNodeOfferingsApi apiInstance = new DescribeReservedNodeOfferingsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeOfferingId = reservedNodeOfferingId_example; // String | The unique identifier for the offering.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_36 result = apiInstance.describeReservedNodeOfferings(apiecoKey, reservedNodeOfferingId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeReservedNodeOfferingsApi#describeReservedNodeOfferings");
            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 *reservedNodeOfferingId = reservedNodeOfferingId_example; // The unique identifier for the offering. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeReservedNodeOfferingsWith:apiecoKey
    reservedNodeOfferingId:reservedNodeOfferingId
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_36 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_.DescribeReservedNodeOfferingsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'reservedNodeOfferingId': reservedNodeOfferingId_example, // {String} The unique identifier for the offering.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeReservedNodeOfferingsExample
    {
        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 DescribeReservedNodeOfferingsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var reservedNodeOfferingId = reservedNodeOfferingId_example;  // String | The unique identifier for the offering. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_36 result = apiInstance.describeReservedNodeOfferings(apiecoKey, reservedNodeOfferingId, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeReservedNodeOfferingsApi.describeReservedNodeOfferings: " + 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\DescribeReservedNodeOfferingsApi();
$apiecoKey = apiecoKey_example; // String | 
$reservedNodeOfferingId = reservedNodeOfferingId_example; // String | The unique identifier for the offering.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

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

# 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::DescribeReservedNodeOfferingsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $reservedNodeOfferingId = reservedNodeOfferingId_example; # String | The unique identifier for the offering.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeReservedNodeOfferings(apiecoKey => $apiecoKey, reservedNodeOfferingId => $reservedNodeOfferingId, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeReservedNodeOfferingsApi->describeReservedNodeOfferings: $@\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.DescribeReservedNodeOfferingsApi()
apiecoKey = apiecoKey_example # String | 
reservedNodeOfferingId = reservedNodeOfferingId_example # String | The unique identifier for the offering. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_reserved_node_offerings(apiecoKey, reservedNodeOfferingId=reservedNodeOfferingId, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeReservedNodeOfferingsApi->describeReservedNodeOfferings: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ReservedNodeOfferingId
String
The unique identifier for the offering.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeReservedNodes

describeReservedNodes

Returns the descriptions of the reserved nodes.


/DescribeReservedNodes

Usage and SDK Samples

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

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

public class DescribeReservedNodesApiExample {

    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");

        DescribeReservedNodesApi apiInstance = new DescribeReservedNodesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeId = reservedNodeId_example; // String | Identifier for the node reservation.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_37 result = apiInstance.describeReservedNodes(apiecoKey, reservedNodeId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeReservedNodesApi#describeReservedNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeReservedNodesApi;

public class DescribeReservedNodesApiExample {

    public static void main(String[] args) {
        DescribeReservedNodesApi apiInstance = new DescribeReservedNodesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeId = reservedNodeId_example; // String | Identifier for the node reservation.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_37 result = apiInstance.describeReservedNodes(apiecoKey, reservedNodeId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeReservedNodesApi#describeReservedNodes");
            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; // Identifier for the node reservation. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeReservedNodesWith:apiecoKey
    reservedNodeId:reservedNodeId
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_37 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_.DescribeReservedNodesApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'reservedNodeId': reservedNodeId_example, // {String} Identifier for the node reservation.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeReservedNodesExample
    {
        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 DescribeReservedNodesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var reservedNodeId = reservedNodeId_example;  // String | Identifier for the node reservation. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_37 result = apiInstance.describeReservedNodes(apiecoKey, reservedNodeId, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeReservedNodesApi.describeReservedNodes: " + 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\DescribeReservedNodesApi();
$apiecoKey = apiecoKey_example; // String | 
$reservedNodeId = reservedNodeId_example; // String | Identifier for the node reservation.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

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

# 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::DescribeReservedNodesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $reservedNodeId = reservedNodeId_example; # String | Identifier for the node reservation.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeReservedNodes(apiecoKey => $apiecoKey, reservedNodeId => $reservedNodeId, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeReservedNodesApi->describeReservedNodes: $@\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.DescribeReservedNodesApi()
apiecoKey = apiecoKey_example # String | 
reservedNodeId = reservedNodeId_example # String | Identifier for the node reservation. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_reserved_nodes(apiecoKey, reservedNodeId=reservedNodeId, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeReservedNodesApi->describeReservedNodes: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ReservedNodeId
String
Identifier for the node reservation.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeResize

describeResize

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.


/DescribeResize

Usage and SDK Samples

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

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

public class DescribeResizeApiExample {

    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");

        DescribeResizeApi apiInstance = new DescribeResizeApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
        try {
            inline_response_200_38 result = apiInstance.describeResize(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeResizeApi#describeResize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeResizeApi;

public class DescribeResizeApiExample {

    public static void main(String[] args) {
        DescribeResizeApi apiInstance = new DescribeResizeApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
        try {
            inline_response_200_38 result = apiInstance.describeResize(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeResizeApi#describeResize");
            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 of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.

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

[apiInstance describeResizeWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_38 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_.DescribeResizeApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.


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

namespace Example
{
    public class describeResizeExample
    {
        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 DescribeResizeApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.

            try
            {
                inline_response_200_38 result = apiInstance.describeResize(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeResizeApi.describeResize: " + 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\DescribeResizeApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.

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

# 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::DescribeResizeApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.

eval { 
    my $result = $api_instance->describeResize(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeResizeApi->describeResize: $@\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.DescribeResizeApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeScheduledActions

describeScheduledActions

Describes properties of scheduled actions.


/DescribeScheduledActions

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeScheduledActions?Active=&EndTime=&Filters.ScheduledActionFilter.N=&ScheduledActionName=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeScheduledActionsApi;

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

public class DescribeScheduledActionsApiExample {

    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");

        DescribeScheduledActionsApi apiInstance = new DescribeScheduledActionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean active = true; // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
        String endTime = endTime_example; // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
        array[String] filters.ScheduledActionFilter.N = ; // array[String] | List of scheduled action filters.
        Boolean scheduledActionName = true; // Boolean | The name of the scheduled action to retrieve..
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_39 result = apiInstance.describeScheduledActions(apiecoKey, active, endTime, filters.ScheduledActionFilter.N, scheduledActionName, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeScheduledActionsApi#describeScheduledActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeScheduledActionsApi;

public class DescribeScheduledActionsApiExample {

    public static void main(String[] args) {
        DescribeScheduledActionsApi apiInstance = new DescribeScheduledActionsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean active = true; // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
        String endTime = endTime_example; // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
        array[String] filters.ScheduledActionFilter.N = ; // array[String] | List of scheduled action filters.
        Boolean scheduledActionName = true; // Boolean | The name of the scheduled action to retrieve..
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_39 result = apiInstance.describeScheduledActions(apiecoKey, active, endTime, filters.ScheduledActionFilter.N, scheduledActionName, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeScheduledActionsApi#describeScheduledActions");
            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 *active = true; // If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. (optional)
String *endTime = endTime_example; // The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. (optional)
array[String] *filters.ScheduledActionFilter.N = ; // List of scheduled action filters. (optional)
Boolean *scheduledActionName = true; // The name of the scheduled action to retrieve.. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeScheduledActionsWith:apiecoKey
    active:active
    endTime:endTime
    filters.ScheduledActionFilter.N:filters.ScheduledActionFilter.N
    scheduledActionName:scheduledActionName
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_39 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_.DescribeScheduledActionsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'active': true, // {Boolean} If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
  'endTime': endTime_example, // {String} The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
  'filters.ScheduledActionFilter.N': , // {array[String]} List of scheduled action filters.
  'scheduledActionName': true, // {Boolean} The name of the scheduled action to retrieve..
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeScheduledActionsExample
    {
        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 DescribeScheduledActionsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var active = true;  // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. (optional) 
            var endTime = endTime_example;  // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. (optional) 
            var filters.ScheduledActionFilter.N = new array[String](); // array[String] | List of scheduled action filters. (optional) 
            var scheduledActionName = true;  // Boolean | The name of the scheduled action to retrieve.. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_39 result = apiInstance.describeScheduledActions(apiecoKey, active, endTime, filters.ScheduledActionFilter.N, scheduledActionName, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeScheduledActionsApi.describeScheduledActions: " + 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\DescribeScheduledActionsApi();
$apiecoKey = apiecoKey_example; // String | 
$active = true; // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
$endTime = endTime_example; // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
$filters.ScheduledActionFilter.N = ; // array[String] | List of scheduled action filters.
$scheduledActionName = true; // Boolean | The name of the scheduled action to retrieve..
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

try {
    $result = $api_instance->describeScheduledActions($apiecoKey, $active, $endTime, $filters.ScheduledActionFilter.N, $scheduledActionName, $marker, $maxRecords);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeScheduledActionsApi->describeScheduledActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeScheduledActionsApi;

# 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::DescribeScheduledActionsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $active = true; # Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
my $endTime = endTime_example; # String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
my $filters.ScheduledActionFilter.N = []; # array[String] | List of scheduled action filters.
my $scheduledActionName = true; # Boolean | The name of the scheduled action to retrieve..
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeScheduledActions(apiecoKey => $apiecoKey, active => $active, endTime => $endTime, filters.ScheduledActionFilter.N => $filters.ScheduledActionFilter.N, scheduledActionName => $scheduledActionName, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeScheduledActionsApi->describeScheduledActions: $@\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.DescribeScheduledActionsApi()
apiecoKey = apiecoKey_example # String | 
active = true # Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. (optional)
endTime = endTime_example # String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. (optional)
filters.ScheduledActionFilter.N =  # array[String] | List of scheduled action filters. (optional)
scheduledActionName = true # Boolean | The name of the scheduled action to retrieve.. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_scheduled_actions(apiecoKey, active=active, endTime=endTime, filters.ScheduledActionFilter.N=filters.ScheduledActionFilter.N, scheduledActionName=scheduledActionName, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeScheduledActionsApi->describeScheduledActions: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
Active
Boolean
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
EndTime
String
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
Filters.ScheduledActionFilter.N
array[String]
List of scheduled action filters.
ScheduledActionName
Boolean
The name of the scheduled action to retrieve..
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeSnapshotCopyGrants

describeSnapshotCopyGrants

Returns a list of snapshot copy grants owned by the AWS account in the destination region.


/DescribeSnapshotCopyGrants

Usage and SDK Samples

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

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

public class DescribeSnapshotCopyGrantsApiExample {

    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");

        DescribeSnapshotCopyGrantsApi apiInstance = new DescribeSnapshotCopyGrantsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant.
        try {
            inline_response_200_40 result = apiInstance.describeSnapshotCopyGrants(apiecoKey, snapshotCopyGrantName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeSnapshotCopyGrantsApi#describeSnapshotCopyGrants");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeSnapshotCopyGrantsApi;

public class DescribeSnapshotCopyGrantsApiExample {

    public static void main(String[] args) {
        DescribeSnapshotCopyGrantsApi apiInstance = new DescribeSnapshotCopyGrantsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant.
        try {
            inline_response_200_40 result = apiInstance.describeSnapshotCopyGrants(apiecoKey, snapshotCopyGrantName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeSnapshotCopyGrantsApi#describeSnapshotCopyGrants");
            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. (optional)

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

[apiInstance describeSnapshotCopyGrantsWith:apiecoKey
    snapshotCopyGrantName:snapshotCopyGrantName
              completionHandler: ^(inline_response_200_40 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_.DescribeSnapshotCopyGrantsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'snapshotCopyGrantName': snapshotCopyGrantName_example // {String} The name of the snapshot copy grant.
};

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

namespace Example
{
    public class describeSnapshotCopyGrantsExample
    {
        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 DescribeSnapshotCopyGrantsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var snapshotCopyGrantName = snapshotCopyGrantName_example;  // String | The name of the snapshot copy grant. (optional) 

            try
            {
                inline_response_200_40 result = apiInstance.describeSnapshotCopyGrants(apiecoKey, snapshotCopyGrantName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeSnapshotCopyGrantsApi.describeSnapshotCopyGrants: " + 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\DescribeSnapshotCopyGrantsApi();
$apiecoKey = apiecoKey_example; // String | 
$snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant.

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

# 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::DescribeSnapshotCopyGrantsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $snapshotCopyGrantName = snapshotCopyGrantName_example; # String | The name of the snapshot copy grant.

eval { 
    my $result = $api_instance->describeSnapshotCopyGrants(apiecoKey => $apiecoKey, snapshotCopyGrantName => $snapshotCopyGrantName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeSnapshotCopyGrantsApi->describeSnapshotCopyGrants: $@\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.DescribeSnapshotCopyGrantsApi()
apiecoKey = apiecoKey_example # String | 
snapshotCopyGrantName = snapshotCopyGrantName_example # String | The name of the snapshot copy grant. (optional)

try: 
    api_response = api_instance.describe_snapshot_copy_grants(apiecoKey, snapshotCopyGrantName=snapshotCopyGrantName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeSnapshotCopyGrantsApi->describeSnapshotCopyGrants: %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.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeSnapshotSchedules

describeSnapshotSchedules

Returns a list of snapshot schedules.


/DescribeSnapshotSchedules

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeSnapshotSchedules?ClusterIdentifier=&ScheduleIdentifier=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeSnapshotSchedulesApi;

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

public class DescribeSnapshotSchedulesApiExample {

    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");

        DescribeSnapshotSchedulesApi apiInstance = new DescribeSnapshotSchedulesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier for the cluster whose snapshot schedules you want to view.
        String scheduleIdentifier = scheduleIdentifier_example; // String | A unique identifier for a snapshot schedule.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_41 result = apiInstance.describeSnapshotSchedules(apiecoKey, clusterIdentifier, scheduleIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeSnapshotSchedulesApi#describeSnapshotSchedules");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeSnapshotSchedulesApi;

public class DescribeSnapshotSchedulesApiExample {

    public static void main(String[] args) {
        DescribeSnapshotSchedulesApi apiInstance = new DescribeSnapshotSchedulesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier for the cluster whose snapshot schedules you want to view.
        String scheduleIdentifier = scheduleIdentifier_example; // String | A unique identifier for a snapshot schedule.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_41 result = apiInstance.describeSnapshotSchedules(apiecoKey, clusterIdentifier, scheduleIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeSnapshotSchedulesApi#describeSnapshotSchedules");
            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 whose snapshot schedules you want to view. (optional)
String *scheduleIdentifier = scheduleIdentifier_example; // A unique identifier for a snapshot schedule. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeSnapshotSchedulesWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    scheduleIdentifier:scheduleIdentifier
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_41 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_.DescribeSnapshotSchedulesApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterIdentifier': clusterIdentifier_example, // {String} The unique identifier for the cluster whose snapshot schedules you want to view.
  'scheduleIdentifier': scheduleIdentifier_example, // {String} A unique identifier for a snapshot schedule.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeSnapshotSchedulesExample
    {
        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 DescribeSnapshotSchedulesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier for the cluster whose snapshot schedules you want to view. (optional) 
            var scheduleIdentifier = scheduleIdentifier_example;  // String | A unique identifier for a snapshot schedule. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_41 result = apiInstance.describeSnapshotSchedules(apiecoKey, clusterIdentifier, scheduleIdentifier, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeSnapshotSchedulesApi.describeSnapshotSchedules: " + 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\DescribeSnapshotSchedulesApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier for the cluster whose snapshot schedules you want to view.
$scheduleIdentifier = scheduleIdentifier_example; // String | A unique identifier for a snapshot schedule.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeSnapshotSchedules($apiecoKey, $clusterIdentifier, $scheduleIdentifier, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeSnapshotSchedulesApi->describeSnapshotSchedules: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeSnapshotSchedulesApi;

# 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::DescribeSnapshotSchedulesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier for the cluster whose snapshot schedules you want to view.
my $scheduleIdentifier = scheduleIdentifier_example; # String | A unique identifier for a snapshot schedule.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeSnapshotSchedules(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, scheduleIdentifier => $scheduleIdentifier, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeSnapshotSchedulesApi->describeSnapshotSchedules: $@\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.DescribeSnapshotSchedulesApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The unique identifier for the cluster whose snapshot schedules you want to view. (optional)
scheduleIdentifier = scheduleIdentifier_example # String | A unique identifier for a snapshot schedule. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_snapshot_schedules(apiecoKey, clusterIdentifier=clusterIdentifier, scheduleIdentifier=scheduleIdentifier, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeSnapshotSchedulesApi->describeSnapshotSchedules: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
String
The unique identifier for the cluster whose snapshot schedules you want to view.
ScheduleIdentifier
String
A unique identifier for a snapshot schedule.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeStorage

describeStorage

Returns a list of snapshot schedules.


/DescribeStorage

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeStorage?TotalBackupSizeInMegaBytes=&TotalProvisionedStorageInMegaBytes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeStorageApi;

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

public class DescribeStorageApiExample {

    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");

        DescribeStorageApi apiInstance = new DescribeStorageApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer totalBackupSizeInMegaBytes = 56; // Integer | The total amount of storage currently used for snapshots.
        Integer totalProvisionedStorageInMegaBytes = 56; // Integer | TotalProvisionedStorageInMegaBytes
        try {
            inline_response_200_42 result = apiInstance.describeStorage(apiecoKey, totalBackupSizeInMegaBytes, totalProvisionedStorageInMegaBytes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeStorageApi#describeStorage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeStorageApi;

public class DescribeStorageApiExample {

    public static void main(String[] args) {
        DescribeStorageApi apiInstance = new DescribeStorageApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer totalBackupSizeInMegaBytes = 56; // Integer | The total amount of storage currently used for snapshots.
        Integer totalProvisionedStorageInMegaBytes = 56; // Integer | TotalProvisionedStorageInMegaBytes
        try {
            inline_response_200_42 result = apiInstance.describeStorage(apiecoKey, totalBackupSizeInMegaBytes, totalProvisionedStorageInMegaBytes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeStorageApi#describeStorage");
            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; // 
Integer *totalBackupSizeInMegaBytes = 56; // The total amount of storage currently used for snapshots. (optional)
Integer *totalProvisionedStorageInMegaBytes = 56; // TotalProvisionedStorageInMegaBytes (optional)

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

[apiInstance describeStorageWith:apiecoKey
    totalBackupSizeInMegaBytes:totalBackupSizeInMegaBytes
    totalProvisionedStorageInMegaBytes:totalProvisionedStorageInMegaBytes
              completionHandler: ^(inline_response_200_42 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_.DescribeStorageApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'totalBackupSizeInMegaBytes': 56, // {Integer} The total amount of storage currently used for snapshots.
  'totalProvisionedStorageInMegaBytes': 56 // {Integer} TotalProvisionedStorageInMegaBytes
};

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

namespace Example
{
    public class describeStorageExample
    {
        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 DescribeStorageApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var totalBackupSizeInMegaBytes = 56;  // Integer | The total amount of storage currently used for snapshots. (optional) 
            var totalProvisionedStorageInMegaBytes = 56;  // Integer | TotalProvisionedStorageInMegaBytes (optional) 

            try
            {
                inline_response_200_42 result = apiInstance.describeStorage(apiecoKey, totalBackupSizeInMegaBytes, totalProvisionedStorageInMegaBytes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeStorageApi.describeStorage: " + 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\DescribeStorageApi();
$apiecoKey = apiecoKey_example; // String | 
$totalBackupSizeInMegaBytes = 56; // Integer | The total amount of storage currently used for snapshots.
$totalProvisionedStorageInMegaBytes = 56; // Integer | TotalProvisionedStorageInMegaBytes

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

# 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::DescribeStorageApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $totalBackupSizeInMegaBytes = 56; # Integer | The total amount of storage currently used for snapshots.
my $totalProvisionedStorageInMegaBytes = 56; # Integer | TotalProvisionedStorageInMegaBytes

eval { 
    my $result = $api_instance->describeStorage(apiecoKey => $apiecoKey, totalBackupSizeInMegaBytes => $totalBackupSizeInMegaBytes, totalProvisionedStorageInMegaBytes => $totalProvisionedStorageInMegaBytes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeStorageApi->describeStorage: $@\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.DescribeStorageApi()
apiecoKey = apiecoKey_example # String | 
totalBackupSizeInMegaBytes = 56 # Integer | The total amount of storage currently used for snapshots. (optional)
totalProvisionedStorageInMegaBytes = 56 # Integer | TotalProvisionedStorageInMegaBytes (optional)

try: 
    api_response = api_instance.describe_storage(apiecoKey, totalBackupSizeInMegaBytes=totalBackupSizeInMegaBytes, totalProvisionedStorageInMegaBytes=totalProvisionedStorageInMegaBytes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeStorageApi->describeStorage: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
TotalBackupSizeInMegaBytes
Integer
The total amount of storage currently used for snapshots.
TotalProvisionedStorageInMegaBytes
Integer
TotalProvisionedStorageInMegaBytes

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeTableRestoreStatus

describeTableRestoreStatus

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don`t specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.


/DescribeTableRestoreStatus

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeTableRestoreStatus?ClusterIdentifier=&TableRestoreRequestId=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeTableRestoreStatusApi;

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

public class DescribeTableRestoreStatusApiExample {

    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");

        DescribeTableRestoreStatusApi apiInstance = new DescribeTableRestoreStatusApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The Amazon Redshift cluster that the table is being restored to.
        String tableRestoreRequestId = tableRestoreRequestId_example; // String | The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_43 result = apiInstance.describeTableRestoreStatus(apiecoKey, clusterIdentifier, tableRestoreRequestId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeTableRestoreStatusApi#describeTableRestoreStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeTableRestoreStatusApi;

public class DescribeTableRestoreStatusApiExample {

    public static void main(String[] args) {
        DescribeTableRestoreStatusApi apiInstance = new DescribeTableRestoreStatusApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The Amazon Redshift cluster that the table is being restored to.
        String tableRestoreRequestId = tableRestoreRequestId_example; // String | The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_43 result = apiInstance.describeTableRestoreStatus(apiecoKey, clusterIdentifier, tableRestoreRequestId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeTableRestoreStatusApi#describeTableRestoreStatus");
            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 Amazon Redshift cluster that the table is being restored to. (optional)
String *tableRestoreRequestId = tableRestoreRequestId_example; // The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance describeTableRestoreStatusWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    tableRestoreRequestId:tableRestoreRequestId
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_43 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_.DescribeTableRestoreStatusApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterIdentifier': clusterIdentifier_example, // {String} The Amazon Redshift cluster that the table is being restored to.
  'tableRestoreRequestId': tableRestoreRequestId_example, // {String} The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class describeTableRestoreStatusExample
    {
        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 DescribeTableRestoreStatusApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The Amazon Redshift cluster that the table is being restored to. (optional) 
            var tableRestoreRequestId = tableRestoreRequestId_example;  // String | The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_43 result = apiInstance.describeTableRestoreStatus(apiecoKey, clusterIdentifier, tableRestoreRequestId, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeTableRestoreStatusApi.describeTableRestoreStatus: " + 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\DescribeTableRestoreStatusApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The Amazon Redshift cluster that the table is being restored to.
$tableRestoreRequestId = tableRestoreRequestId_example; // String | The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

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

# 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::DescribeTableRestoreStatusApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The Amazon Redshift cluster that the table is being restored to.
my $tableRestoreRequestId = tableRestoreRequestId_example; # String | The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->describeTableRestoreStatus(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, tableRestoreRequestId => $tableRestoreRequestId, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeTableRestoreStatusApi->describeTableRestoreStatus: $@\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.DescribeTableRestoreStatusApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The Amazon Redshift cluster that the table is being restored to. (optional)
tableRestoreRequestId = tableRestoreRequestId_example # String | The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.describe_table_restore_status(apiecoKey, clusterIdentifier=clusterIdentifier, tableRestoreRequestId=tableRestoreRequestId, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeTableRestoreStatusApi->describeTableRestoreStatus: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
String
The Amazon Redshift cluster that the table is being restored to.
TableRestoreRequestId
String
The identifier of the table restore request to return status for. If you don`t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DescribeTags

describeTags

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.


/DescribeTags

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/DescribeTags?ResourceName=&ResourceType=&Marker=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescribeTagsApi;

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

public class DescribeTagsApiExample {

    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");

        DescribeTagsApi apiInstance = new DescribeTagsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1..
        String resourceType = resourceType_example; // String | The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_44 result = apiInstance.describeTags(apiecoKey, resourceName, resourceType, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeTagsApi#describeTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescribeTagsApi;

public class DescribeTagsApiExample {

    public static void main(String[] args) {
        DescribeTagsApi apiInstance = new DescribeTagsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1..
        String resourceType = resourceType_example; // String | The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant.
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_44 result = apiInstance.describeTags(apiecoKey, resourceName, resourceType, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescribeTagsApi#describeTags");
            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) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.. (optional)
String *resourceType = resourceType_example; // The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance describeTagsWith:apiecoKey
    resourceName:resourceName
    resourceType:resourceType
    marker:marker
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_44 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_.DescribeTagsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'resourceName': resourceName_example, // {String} The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1..
  'resourceType': resourceType_example, // {String} The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant.
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class describeTagsExample
    {
        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 DescribeTagsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var resourceName = resourceName_example;  // String | The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.. (optional) 
            var resourceType = resourceType_example;  // String | The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_44 result = apiInstance.describeTags(apiecoKey, resourceName, resourceType, marker, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescribeTagsApi.describeTags: " + 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\DescribeTagsApi();
$apiecoKey = apiecoKey_example; // String | 
$resourceName = resourceName_example; // String | The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1..
$resourceType = resourceType_example; // String | The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant.
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->describeTags($apiecoKey, $resourceName, $resourceType, $marker, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescribeTagsApi->describeTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescribeTagsApi;

# 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::DescribeTagsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $resourceName = resourceName_example; # String | The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1..
my $resourceType = resourceType_example; # String | The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant.
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->describeTags(apiecoKey => $apiecoKey, resourceName => $resourceName, resourceType => $resourceType, marker => $marker, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescribeTagsApi->describeTags: $@\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.DescribeTagsApi()
apiecoKey = apiecoKey_example # String | 
resourceName = resourceName_example # String | The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.. (optional)
resourceType = resourceType_example # String | The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.describe_tags(apiecoKey, resourceName=resourceName, resourceType=resourceType, marker=marker, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescribeTagsApi->describeTags: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ResourceName
String
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1..
ResourceType
String
The type of resource with which you want to view tags. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group Snapshot copy grant.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DisableLogging

disableLogging

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.


/DisableLogging

Usage and SDK Samples

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

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

public class DisableLoggingApiExample {

    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");

        DisableLoggingApi apiInstance = new DisableLoggingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
        try {
            inline_response_200_45 result = apiInstance.disableLogging(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DisableLoggingApi#disableLogging");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DisableLoggingApi;

public class DisableLoggingApiExample {

    public static void main(String[] args) {
        DisableLoggingApi apiInstance = new DisableLoggingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
        try {
            inline_response_200_45 result = apiInstance.disableLogging(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DisableLoggingApi#disableLogging");
            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 on which logging is to be stopped.
Example: examplecluster (optional)

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

[apiInstance disableLoggingWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_45 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_.DisableLoggingApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterIdentifier': clusterIdentifier_example // {String} The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
};

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

namespace Example
{
    public class disableLoggingExample
    {
        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 DisableLoggingApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster on which logging is to be stopped.
Example: examplecluster (optional) 

            try
            {
                inline_response_200_45 result = apiInstance.disableLogging(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DisableLoggingApi.disableLogging: " + 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\DisableLoggingApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster on which logging is to be stopped.
Example: examplecluster

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

# 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::DisableLoggingApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster on which logging is to be stopped.
Example: examplecluster

eval { 
    my $result = $api_instance->disableLogging(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DisableLoggingApi->disableLogging: $@\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.DisableLoggingApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster on which logging is to be stopped.
Example: examplecluster (optional)

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
String
The identifier of the cluster on which logging is to be stopped. Example: examplecluster

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


DisableSnapshotCopy

disableSnapshotCopy

Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.


/DisableSnapshotCopy

Usage and SDK Samples

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

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

public class DisableSnapshotCopyApiExample {

    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");

        DisableSnapshotCopyApi apiInstance = new DisableSnapshotCopyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
        try {
            inline_response_200_7 result = apiInstance.disableSnapshotCopy(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DisableSnapshotCopyApi#disableSnapshotCopy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DisableSnapshotCopyApi;

public class DisableSnapshotCopyApiExample {

    public static void main(String[] args) {
        DisableSnapshotCopyApi apiInstance = new DisableSnapshotCopyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
        try {
            inline_response_200_7 result = apiInstance.disableSnapshotCopy(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DisableSnapshotCopyApi#disableSnapshotCopy");
            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 of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. (optional)

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

[apiInstance disableSnapshotCopyWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              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_.DisableSnapshotCopyApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterIdentifier': clusterIdentifier_example // {String} The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
};

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

namespace Example
{
    public class disableSnapshotCopyExample
    {
        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 DisableSnapshotCopyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. (optional) 

            try
            {
                inline_response_200_7 result = apiInstance.disableSnapshotCopy(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DisableSnapshotCopyApi.disableSnapshotCopy: " + 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\DisableSnapshotCopyApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

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

# 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::DisableSnapshotCopyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

eval { 
    my $result = $api_instance->disableSnapshotCopy(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DisableSnapshotCopyApi->disableSnapshotCopy: $@\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.DisableSnapshotCopyApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. (optional)

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
String
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


EnableLogging

enableLogging

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.


/EnableLogging

Usage and SDK Samples

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

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

public class EnableLoggingApiExample {

    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");

        EnableLoggingApi apiInstance = new EnableLoggingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String bucketName = bucketName_example; // String | The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster on which logging is to be started.
Example: examplecluster
        String s3KeyPrefix = s3KeyPrefix_example; // String | The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger
        try {
            inline_response_200_46 result = apiInstance.enableLogging(apiecoKey, bucketName, clusterIdentifier, s3KeyPrefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnableLoggingApi#enableLogging");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EnableLoggingApi;

public class EnableLoggingApiExample {

    public static void main(String[] args) {
        EnableLoggingApi apiInstance = new EnableLoggingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String bucketName = bucketName_example; // String | The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster on which logging is to be started.
Example: examplecluster
        String s3KeyPrefix = s3KeyPrefix_example; // String | The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger
        try {
            inline_response_200_46 result = apiInstance.enableLogging(apiecoKey, bucketName, clusterIdentifier, s3KeyPrefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnableLoggingApi#enableLogging");
            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 *bucketName = bucketName_example; // The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
String *clusterIdentifier = clusterIdentifier_example; // The identifier of the cluster on which logging is to be started.
Example: examplecluster
String *s3KeyPrefix = s3KeyPrefix_example; // The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger

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

[apiInstance enableLoggingWith:apiecoKey
    bucketName:bucketName
    clusterIdentifier:clusterIdentifier
    s3KeyPrefix:s3KeyPrefix
              completionHandler: ^(inline_response_200_46 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_.EnableLoggingApi()

var apiecoKey = apiecoKey_example; // {String} 

var bucketName = bucketName_example; // {String} The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions

var clusterIdentifier = clusterIdentifier_example; // {String} The identifier of the cluster on which logging is to be started.
Example: examplecluster

var s3KeyPrefix = s3KeyPrefix_example; // {String} The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger


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

namespace Example
{
    public class enableLoggingExample
    {
        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 EnableLoggingApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var bucketName = bucketName_example;  // String | The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster on which logging is to be started.
Example: examplecluster
            var s3KeyPrefix = s3KeyPrefix_example;  // String | The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger

            try
            {
                inline_response_200_46 result = apiInstance.enableLogging(apiecoKey, bucketName, clusterIdentifier, s3KeyPrefix);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnableLoggingApi.enableLogging: " + 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\EnableLoggingApi();
$apiecoKey = apiecoKey_example; // String | 
$bucketName = bucketName_example; // String | The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster on which logging is to be started.
Example: examplecluster
$s3KeyPrefix = s3KeyPrefix_example; // String | The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger

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

# 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::EnableLoggingApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $bucketName = bucketName_example; # String | The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster on which logging is to be started.
Example: examplecluster
my $s3KeyPrefix = s3KeyPrefix_example; # String | The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger

eval { 
    my $result = $api_instance->enableLogging(apiecoKey => $apiecoKey, bucketName => $bucketName, clusterIdentifier => $clusterIdentifier, s3KeyPrefix => $s3KeyPrefix);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnableLoggingApi->enableLogging: $@\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.EnableLoggingApi()
apiecoKey = apiecoKey_example # String | 
bucketName = bucketName_example # String | The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster on which logging is to be started.
Example: examplecluster
s3KeyPrefix = s3KeyPrefix_example # String | The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger

try: 
    api_response = api_instance.enable_logging(apiecoKey, bucketName, clusterIdentifier, s3KeyPrefix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnableLoggingApi->enableLogging: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
BucketName*
String
The name of an existing S3 bucket where the log files are to be stored. Constraints: Must be in the same region as the cluster The cluster must have read bucket and put object permissions
Required
ClusterIdentifier*
String
The identifier of the cluster on which logging is to be started. Example: examplecluster
Required
S3KeyPrefix*
String
The prefix applied to the log file names. Constraints: Cannot exceed 512 characters Cannot contain spaces( ), double quotes ("), single quotes , a backslash (\), or control characters. The hexadecimal codes for invalid characters are: x00 to x20 x22 x27 x5c x7f or larger
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


EnableSnapshotCopy

enableSnapshotCopy

Enables the automatic copy of snapshots from one region to another region for a specified cluster.


/EnableSnapshotCopy

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/EnableSnapshotCopy?ManualSnapshotRetentionPeriod=&DestinationRegion=&RetentionPeriod=&SnapshotCopyGrantName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnableSnapshotCopyApi;

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

public class EnableSnapshotCopyApiExample {

    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");

        EnableSnapshotCopyApi apiInstance = new EnableSnapshotCopyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String destinationRegion = destinationRegion_example; // String | The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
        Integer retentionPeriod = 56; // Integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
        Integer manualSnapshotRetentionPeriod = 56; // Integer | TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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.
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
        try {
            inline_response_200_7 result = apiInstance.enableSnapshotCopy(apiecoKey, destinationRegion, retentionPeriod, manualSnapshotRetentionPeriod, snapshotCopyGrantName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnableSnapshotCopyApi#enableSnapshotCopy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EnableSnapshotCopyApi;

public class EnableSnapshotCopyApiExample {

    public static void main(String[] args) {
        EnableSnapshotCopyApi apiInstance = new EnableSnapshotCopyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String destinationRegion = destinationRegion_example; // String | The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
        Integer retentionPeriod = 56; // Integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
        Integer manualSnapshotRetentionPeriod = 56; // Integer | TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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.
        String snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
        try {
            inline_response_200_7 result = apiInstance.enableSnapshotCopy(apiecoKey, destinationRegion, retentionPeriod, manualSnapshotRetentionPeriod, snapshotCopyGrantName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnableSnapshotCopyApi#enableSnapshotCopy");
            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 *destinationRegion = destinationRegion_example; // The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
Integer *retentionPeriod = 56; // The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
Integer *manualSnapshotRetentionPeriod = 56; // TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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. (optional)
String *snapshotCopyGrantName = snapshotCopyGrantName_example; // The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. (optional)

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

[apiInstance enableSnapshotCopyWith:apiecoKey
    destinationRegion:destinationRegion
    retentionPeriod:retentionPeriod
    manualSnapshotRetentionPeriod:manualSnapshotRetentionPeriod
    snapshotCopyGrantName:snapshotCopyGrantName
              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_.EnableSnapshotCopyApi()

var apiecoKey = apiecoKey_example; // {String} 

var destinationRegion = destinationRegion_example; // {String} The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

var retentionPeriod = 56; // {Integer} The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.

var opts = { 
  'manualSnapshotRetentionPeriod': 56, // {Integer} TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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.
  'snapshotCopyGrantName': snapshotCopyGrantName_example // {String} The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
};

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

namespace Example
{
    public class enableSnapshotCopyExample
    {
        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 EnableSnapshotCopyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var destinationRegion = destinationRegion_example;  // String | The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
            var retentionPeriod = 56;  // Integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
            var manualSnapshotRetentionPeriod = 56;  // Integer | TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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. (optional) 
            var snapshotCopyGrantName = snapshotCopyGrantName_example;  // String | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. (optional) 

            try
            {
                inline_response_200_7 result = apiInstance.enableSnapshotCopy(apiecoKey, destinationRegion, retentionPeriod, manualSnapshotRetentionPeriod, snapshotCopyGrantName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnableSnapshotCopyApi.enableSnapshotCopy: " + 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\EnableSnapshotCopyApi();
$apiecoKey = apiecoKey_example; // String | 
$destinationRegion = destinationRegion_example; // String | The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
$retentionPeriod = 56; // Integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
$manualSnapshotRetentionPeriod = 56; // Integer | TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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.
$snapshotCopyGrantName = snapshotCopyGrantName_example; // String | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

try {
    $result = $api_instance->enableSnapshotCopy($apiecoKey, $destinationRegion, $retentionPeriod, $manualSnapshotRetentionPeriod, $snapshotCopyGrantName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnableSnapshotCopyApi->enableSnapshotCopy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnableSnapshotCopyApi;

# 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::EnableSnapshotCopyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $destinationRegion = destinationRegion_example; # String | The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
my $retentionPeriod = 56; # Integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
my $manualSnapshotRetentionPeriod = 56; # Integer | TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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.
my $snapshotCopyGrantName = snapshotCopyGrantName_example; # String | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

eval { 
    my $result = $api_instance->enableSnapshotCopy(apiecoKey => $apiecoKey, destinationRegion => $destinationRegion, retentionPeriod => $retentionPeriod, manualSnapshotRetentionPeriod => $manualSnapshotRetentionPeriod, snapshotCopyGrantName => $snapshotCopyGrantName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnableSnapshotCopyApi->enableSnapshotCopy: $@\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.EnableSnapshotCopyApi()
apiecoKey = apiecoKey_example # String | 
destinationRegion = destinationRegion_example # String | The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
retentionPeriod = 56 # Integer | The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
manualSnapshotRetentionPeriod = 56 # Integer | TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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. (optional)
snapshotCopyGrantName = snapshotCopyGrantName_example # String | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. (optional)

try: 
    api_response = api_instance.enable_snapshot_copy(apiecoKey, destinationRegion, retentionPeriod, manualSnapshotRetentionPeriod=manualSnapshotRetentionPeriod, snapshotCopyGrantName=snapshotCopyGrantName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnableSnapshotCopyApi->enableSnapshotCopy: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ManualSnapshotRetentionPeriod
Integer
TThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. 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.
DestinationRegion*
String
The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
Required
RetentionPeriod*
Integer
The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35.
Required
SnapshotCopyGrantName
String
The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


GetClusterCredentials

getClusterCredentials

eturns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.


/GetClusterCredentials

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/GetClusterCredentials?ClusterIdentifier=&DbUser=&AutoCreate=&DbGroups.DbGroup.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GetClusterCredentialsApi;

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

public class GetClusterCredentialsApiExample {

    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");

        GetClusterCredentialsApi apiInstance = new GetClusterCredentialsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String dbUser = dbUser_example; // String | The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
        Boolean autoCreate = true; // Boolean | Create a database user with the name specified for the user named in DbUser if one does not exist.
        Integer clusterIdentifier = 56; // Integer | The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
        String dbGroups.DbGroup.N = dbGroups.DbGroup.N_example; // String | A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
        try {
            inline_response_200_47 result = apiInstance.getClusterCredentials(apiecoKey, dbUser, autoCreate, clusterIdentifier, dbGroups.DbGroup.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GetClusterCredentialsApi#getClusterCredentials");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GetClusterCredentialsApi;

public class GetClusterCredentialsApiExample {

    public static void main(String[] args) {
        GetClusterCredentialsApi apiInstance = new GetClusterCredentialsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String dbUser = dbUser_example; // String | The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
        Boolean autoCreate = true; // Boolean | Create a database user with the name specified for the user named in DbUser if one does not exist.
        Integer clusterIdentifier = 56; // Integer | The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
        String dbGroups.DbGroup.N = dbGroups.DbGroup.N_example; // String | A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
        try {
            inline_response_200_47 result = apiInstance.getClusterCredentials(apiecoKey, dbUser, autoCreate, clusterIdentifier, dbGroups.DbGroup.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GetClusterCredentialsApi#getClusterCredentials");
            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 *dbUser = dbUser_example; // The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Boolean *autoCreate = true; // Create a database user with the name specified for the user named in DbUser if one does not exist.
Integer *clusterIdentifier = 56; // The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive. (optional)
String *dbGroups.DbGroup.N = dbGroups.DbGroup.N_example; // A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. (optional)

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

[apiInstance getClusterCredentialsWith:apiecoKey
    dbUser:dbUser
    autoCreate:autoCreate
    clusterIdentifier:clusterIdentifier
    dbGroups.DbGroup.N:dbGroups.DbGroup.N
              completionHandler: ^(inline_response_200_47 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_.GetClusterCredentialsApi()

var apiecoKey = apiecoKey_example; // {String} 

var dbUser = dbUser_example; // {String} The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

var autoCreate = true; // {Boolean} Create a database user with the name specified for the user named in DbUser if one does not exist.

var opts = { 
  'clusterIdentifier': 56, // {Integer} The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
  'dbGroups.DbGroup.N': dbGroups.DbGroup.N_example // {String} A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
};

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

namespace Example
{
    public class getClusterCredentialsExample
    {
        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 GetClusterCredentialsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var dbUser = dbUser_example;  // String | The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
            var autoCreate = true;  // Boolean | Create a database user with the name specified for the user named in DbUser if one does not exist.
            var clusterIdentifier = 56;  // Integer | The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive. (optional) 
            var dbGroups.DbGroup.N = dbGroups.DbGroup.N_example;  // String | A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. (optional) 

            try
            {
                inline_response_200_47 result = apiInstance.getClusterCredentials(apiecoKey, dbUser, autoCreate, clusterIdentifier, dbGroups.DbGroup.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GetClusterCredentialsApi.getClusterCredentials: " + 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\GetClusterCredentialsApi();
$apiecoKey = apiecoKey_example; // String | 
$dbUser = dbUser_example; // String | The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
$autoCreate = true; // Boolean | Create a database user with the name specified for the user named in DbUser if one does not exist.
$clusterIdentifier = 56; // Integer | The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
$dbGroups.DbGroup.N = dbGroups.DbGroup.N_example; // String | A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

try {
    $result = $api_instance->getClusterCredentials($apiecoKey, $dbUser, $autoCreate, $clusterIdentifier, $dbGroups.DbGroup.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GetClusterCredentialsApi->getClusterCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GetClusterCredentialsApi;

# 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::GetClusterCredentialsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $dbUser = dbUser_example; # String | The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
my $autoCreate = true; # Boolean | Create a database user with the name specified for the user named in DbUser if one does not exist.
my $clusterIdentifier = 56; # Integer | The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
my $dbGroups.DbGroup.N = dbGroups.DbGroup.N_example; # String | A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

eval { 
    my $result = $api_instance->getClusterCredentials(apiecoKey => $apiecoKey, dbUser => $dbUser, autoCreate => $autoCreate, clusterIdentifier => $clusterIdentifier, dbGroups.DbGroup.N => $dbGroups.DbGroup.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GetClusterCredentialsApi->getClusterCredentials: $@\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.GetClusterCredentialsApi()
apiecoKey = apiecoKey_example # String | 
dbUser = dbUser_example # String | The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
autoCreate = true # Boolean | Create a database user with the name specified for the user named in DbUser if one does not exist.
clusterIdentifier = 56 # Integer | The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive. (optional)
dbGroups.DbGroup.N = dbGroups.DbGroup.N_example # String | A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. (optional)

try: 
    api_response = api_instance.get_cluster_credentials(apiecoKey, dbUser, autoCreate, clusterIdentifier=clusterIdentifier, dbGroups.DbGroup.N=dbGroups.DbGroup.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GetClusterCredentialsApi->getClusterCredentials: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
Integer
The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
DbUser*
String
The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesnt exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesnt exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesnt exist in the database. For more information, see CREATE USER in the Amazon Redshift Database Developer Guide. Constraints: Must be 1 to 64 alphanumeric characters or hyphens. The user name cant be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Required
AutoCreate*
Boolean
Create a database user with the name specified for the user named in DbUser if one does not exist.
Required
DbGroups.DbGroup.N
String
A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


GetReservedNodeExchangeOfferings

getReservedNodeExchangeOfferings

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.


/GetReservedNodeExchangeOfferings

Usage and SDK Samples

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

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

public class GetReservedNodeExchangeOfferingsApiExample {

    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");

        GetReservedNodeExchangeOfferingsApi apiInstance = new GetReservedNodeExchangeOfferingsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeId = reservedNodeId_example; // String | A string representing the node identifier for the DC1 Reserved Node to be exchanged.
        String marker = marker_example; // String | A value that indicates the starting point for the next set of ReservedNodeOfferings.
        BigDecimal maxRecords = 8.14; // BigDecimal | An integer setting the maximum number of ReservedNodeOfferings to retrieve.
        try {
            inline_response_200_36 result = apiInstance.getReservedNodeExchangeOfferings(apiecoKey, reservedNodeId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GetReservedNodeExchangeOfferingsApi#getReservedNodeExchangeOfferings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GetReservedNodeExchangeOfferingsApi;

public class GetReservedNodeExchangeOfferingsApiExample {

    public static void main(String[] args) {
        GetReservedNodeExchangeOfferingsApi apiInstance = new GetReservedNodeExchangeOfferingsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeId = reservedNodeId_example; // String | A string representing the node identifier for the DC1 Reserved Node to be exchanged.
        String marker = marker_example; // String | A value that indicates the starting point for the next set of ReservedNodeOfferings.
        BigDecimal maxRecords = 8.14; // BigDecimal | An integer setting the maximum number of ReservedNodeOfferings to retrieve.
        try {
            inline_response_200_36 result = apiInstance.getReservedNodeExchangeOfferings(apiecoKey, reservedNodeId, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GetReservedNodeExchangeOfferingsApi#getReservedNodeExchangeOfferings");
            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 for the DC1 Reserved Node to be exchanged.
String *marker = marker_example; // A value that indicates the starting point for the next set of ReservedNodeOfferings. (optional)
BigDecimal *maxRecords = 8.14; // An integer setting the maximum number of ReservedNodeOfferings to retrieve. (optional)

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

[apiInstance getReservedNodeExchangeOfferingsWith:apiecoKey
    reservedNodeId:reservedNodeId
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_36 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_.GetReservedNodeExchangeOfferingsApi()

var apiecoKey = apiecoKey_example; // {String} 

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

var opts = { 
  'marker': marker_example, // {String} A value that indicates the starting point for the next set of ReservedNodeOfferings.
  'maxRecords': 8.14 // {BigDecimal} An integer setting the maximum number of ReservedNodeOfferings to retrieve.
};

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

namespace Example
{
    public class getReservedNodeExchangeOfferingsExample
    {
        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 GetReservedNodeExchangeOfferingsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var reservedNodeId = reservedNodeId_example;  // String | A string representing the node identifier for the DC1 Reserved Node to be exchanged.
            var marker = marker_example;  // String | A value that indicates the starting point for the next set of ReservedNodeOfferings. (optional) 
            var maxRecords = 8.14;  // BigDecimal | An integer setting the maximum number of ReservedNodeOfferings to retrieve. (optional) 

            try
            {
                inline_response_200_36 result = apiInstance.getReservedNodeExchangeOfferings(apiecoKey, reservedNodeId, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GetReservedNodeExchangeOfferingsApi.getReservedNodeExchangeOfferings: " + 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\GetReservedNodeExchangeOfferingsApi();
$apiecoKey = apiecoKey_example; // String | 
$reservedNodeId = reservedNodeId_example; // String | A string representing the node identifier for the DC1 Reserved Node to be exchanged.
$marker = marker_example; // String | A value that indicates the starting point for the next set of ReservedNodeOfferings.
$maxRecords = 8.14; // BigDecimal | An integer setting the maximum number of ReservedNodeOfferings to retrieve.

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

# 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::GetReservedNodeExchangeOfferingsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $reservedNodeId = reservedNodeId_example; # String | A string representing the node identifier for the DC1 Reserved Node to be exchanged.
my $marker = marker_example; # String | A value that indicates the starting point for the next set of ReservedNodeOfferings.
my $maxRecords = 8.14; # BigDecimal | An integer setting the maximum number of ReservedNodeOfferings to retrieve.

eval { 
    my $result = $api_instance->getReservedNodeExchangeOfferings(apiecoKey => $apiecoKey, reservedNodeId => $reservedNodeId, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GetReservedNodeExchangeOfferingsApi->getReservedNodeExchangeOfferings: $@\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.GetReservedNodeExchangeOfferingsApi()
apiecoKey = apiecoKey_example # String | 
reservedNodeId = reservedNodeId_example # String | A string representing the node identifier for the DC1 Reserved Node to be exchanged.
marker = marker_example # String | A value that indicates the starting point for the next set of ReservedNodeOfferings. (optional)
maxRecords = 8.14 # BigDecimal | An integer setting the maximum number of ReservedNodeOfferings to retrieve. (optional)

try: 
    api_response = api_instance.get_reserved_node_exchange_offerings(apiecoKey, reservedNodeId, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GetReservedNodeExchangeOfferingsApi->getReservedNodeExchangeOfferings: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ReservedNodeId*
String
A string representing the node identifier for the DC1 Reserved Node to be exchanged.
Required
Marker
String
A value that indicates the starting point for the next set of ReservedNodeOfferings.
MaxRecords
BigDecimal
An integer setting the maximum number of ReservedNodeOfferings to retrieve.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyCluster

modifyCluster

Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.


/ModifyCluster

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/ModifyCluster?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.ModifyClusterApi;

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

public class ModifyClusterApiExample {

    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");

        ModifyClusterApi apiInstance = new ModifyClusterApi();
        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.modifyCluster(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 ModifyClusterApi#modifyCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterApi;

public class ModifyClusterApiExample {

    public static void main(String[] args) {
        ModifyClusterApi apiInstance = new ModifyClusterApi();
        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.modifyCluster(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 ModifyClusterApi#modifyCluster");
            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 *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)

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

[apiInstance modifyClusterWith: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_.ModifyClusterApi()

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.modifyCluster(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 modifyClusterExample
    {
        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 ModifyClusterApi();
            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.modifyCluster(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 ModifyClusterApi.modifyCluster: " + 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\ModifyClusterApi();
$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->modifyCluster($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 ModifyClusterApi->modifyCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModifyClusterApi;

# 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::ModifyClusterApi->new();
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->modifyCluster(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 ModifyClusterApi->modifyCluster: $@\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.ModifyClusterApi()
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.modify_cluster(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 ModifyClusterApi->modifyCluster: %s\n" % e)

Parameters

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


ModifyClusterDbRevision

modifyClusterDbRevision

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.


/ModifyClusterDbRevision

Usage and SDK Samples

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

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

public class ModifyClusterDbRevisionApiExample {

    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");

        ModifyClusterDbRevisionApi apiInstance = new ModifyClusterDbRevisionApi();
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
        String revisionTarget = revisionTarget_example; // String | TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
        try {
            inline_response_200_7 result = apiInstance.modifyClusterDbRevision(clusterIdentifier, revisionTarget);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterDbRevisionApi#modifyClusterDbRevision");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterDbRevisionApi;

public class ModifyClusterDbRevisionApiExample {

    public static void main(String[] args) {
        ModifyClusterDbRevisionApi apiInstance = new ModifyClusterDbRevisionApi();
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
        String revisionTarget = revisionTarget_example; // String | TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
        try {
            inline_response_200_7 result = apiInstance.modifyClusterDbRevision(clusterIdentifier, revisionTarget);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterDbRevisionApi#modifyClusterDbRevision");
            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 *clusterIdentifier = clusterIdentifier_example; // The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
String *revisionTarget = revisionTarget_example; // TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

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

[apiInstance modifyClusterDbRevisionWith:clusterIdentifier
    revisionTarget:revisionTarget
              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_.ModifyClusterDbRevisionApi()

var clusterIdentifier = clusterIdentifier_example; // {String} The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster

var revisionTarget = revisionTarget_example; // {String} TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.


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

namespace Example
{
    public class modifyClusterDbRevisionExample
    {
        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 ModifyClusterDbRevisionApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
            var revisionTarget = revisionTarget_example;  // String | TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

            try
            {
                inline_response_200_7 result = apiInstance.modifyClusterDbRevision(clusterIdentifier, revisionTarget);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterDbRevisionApi.modifyClusterDbRevision: " + 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\ModifyClusterDbRevisionApi();
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
$revisionTarget = revisionTarget_example; // String | TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

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

# 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::ModifyClusterDbRevisionApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
my $revisionTarget = revisionTarget_example; # String | TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

eval { 
    my $result = $api_instance->modifyClusterDbRevision(clusterIdentifier => $clusterIdentifier, revisionTarget => $revisionTarget);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterDbRevisionApi->modifyClusterDbRevision: $@\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.ModifyClusterDbRevisionApi()
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
revisionTarget = revisionTarget_example # String | TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

try: 
    api_response = api_instance.modify_cluster_db_revision(clusterIdentifier, revisionTarget)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterDbRevisionApi->modifyClusterDbRevision: %s\n" % e)

Parameters

Query parameters
Name Description
ClusterIdentifier*
String
The unique identifier of a cluster whose database revision you want to modify. Example: examplecluster
Required
RevisionTarget*
String
TThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyClusterIamRoles

modifyClusterIamRoles

Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time.


/ModifyClusterIamRoles

Usage and SDK Samples

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

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

public class ModifyClusterIamRolesApiExample {

    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");

        ModifyClusterIamRolesApi apiInstance = new ModifyClusterIamRolesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
        String addIamRoles = addIamRoles_example; // String | Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
        array[String] removeIamRoles = ; // array[String] | Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
        try {
            inline_response_200_7 result = apiInstance.modifyClusterIamRoles(clusterIdentifier, addIamRoles, removeIamRoles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterIamRolesApi#modifyClusterIamRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterIamRolesApi;

public class ModifyClusterIamRolesApiExample {

    public static void main(String[] args) {
        ModifyClusterIamRolesApi apiInstance = new ModifyClusterIamRolesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
        String addIamRoles = addIamRoles_example; // String | Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
        array[String] removeIamRoles = ; // array[String] | Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
        try {
            inline_response_200_7 result = apiInstance.modifyClusterIamRoles(clusterIdentifier, addIamRoles, removeIamRoles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterIamRolesApi#modifyClusterIamRoles");
            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 *clusterIdentifier = clusterIdentifier_example; // The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
String *addIamRoles = addIamRoles_example; // Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request. (optional)
array[String] *removeIamRoles = ; // Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request. (optional)

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

[apiInstance modifyClusterIamRolesWith:clusterIdentifier
    addIamRoles:addIamRoles
    removeIamRoles:removeIamRoles
              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_.ModifyClusterIamRolesApi()

var clusterIdentifier = clusterIdentifier_example; // {String} The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r

var opts = { 
  'addIamRoles': addIamRoles_example, // {String} Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
  'removeIamRoles':  // {array[String]} Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
};

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

namespace Example
{
    public class modifyClusterIamRolesExample
    {
        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 ModifyClusterIamRolesApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
            var addIamRoles = addIamRoles_example;  // String | Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request. (optional) 
            var removeIamRoles = new array[String](); // array[String] | Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request. (optional) 

            try
            {
                inline_response_200_7 result = apiInstance.modifyClusterIamRoles(clusterIdentifier, addIamRoles, removeIamRoles);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterIamRolesApi.modifyClusterIamRoles: " + 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\ModifyClusterIamRolesApi();
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
$addIamRoles = addIamRoles_example; // String | Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
$removeIamRoles = ; // array[String] | Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

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

# 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::ModifyClusterIamRolesApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
my $addIamRoles = addIamRoles_example; # String | Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
my $removeIamRoles = []; # array[String] | Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

eval { 
    my $result = $api_instance->modifyClusterIamRoles(clusterIdentifier => $clusterIdentifier, addIamRoles => $addIamRoles, removeIamRoles => $removeIamRoles);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterIamRolesApi->modifyClusterIamRoles: $@\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.ModifyClusterIamRolesApi()
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
addIamRoles = addIamRoles_example # String | Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request. (optional)
removeIamRoles =  # array[String] | Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request. (optional)

try: 
    api_response = api_instance.modify_cluster_iam_roles(clusterIdentifier, addIamRoles=addIamRoles, removeIamRoles=removeIamRoles)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterIamRolesApi->modifyClusterIamRoles: %s\n" % e)

Parameters

Query parameters
Name Description
ClusterIdentifier*
String
The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
Required
AddIamRoles
String
Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
RemoveIamRoles
array[String]
Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyClusterMaintenance

modifyClusterMaintenance

Modifies the maintenance settings of a cluster.


/ModifyClusterMaintenance

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/ModifyClusterMaintenance?ClusterIdentifier=&DeferMaintenance=&DeferMaintenanceDuration=&DeferMaintenanceEndTime=&DeferMaintenanceIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModifyClusterMaintenanceApi;

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

public class ModifyClusterMaintenanceApiExample {

    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");

        ModifyClusterMaintenanceApi apiInstance = new ModifyClusterMaintenanceApi();
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
        String deferMaintenance = deferMaintenance_example; // String | A boolean indicating whether to enable the deferred maintenance window.
        String deferMaintenanceDuration = deferMaintenanceDuration_example; // String | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less.
        String deferMaintenanceEndTime = deferMaintenanceEndTime_example; // String | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration.
        String deferMaintenanceIdentifier = deferMaintenanceIdentifier_example; // String | A unique identifier for the deferred maintenance window.
        try {
            inline_response_200_7 result = apiInstance.modifyClusterMaintenance(clusterIdentifier, deferMaintenance, deferMaintenanceDuration, deferMaintenanceEndTime, deferMaintenanceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterMaintenanceApi#modifyClusterMaintenance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterMaintenanceApi;

public class ModifyClusterMaintenanceApiExample {

    public static void main(String[] args) {
        ModifyClusterMaintenanceApi apiInstance = new ModifyClusterMaintenanceApi();
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
        String deferMaintenance = deferMaintenance_example; // String | A boolean indicating whether to enable the deferred maintenance window.
        String deferMaintenanceDuration = deferMaintenanceDuration_example; // String | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less.
        String deferMaintenanceEndTime = deferMaintenanceEndTime_example; // String | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration.
        String deferMaintenanceIdentifier = deferMaintenanceIdentifier_example; // String | A unique identifier for the deferred maintenance window.
        try {
            inline_response_200_7 result = apiInstance.modifyClusterMaintenance(clusterIdentifier, deferMaintenance, deferMaintenanceDuration, deferMaintenanceEndTime, deferMaintenanceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterMaintenanceApi#modifyClusterMaintenance");
            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 *clusterIdentifier = clusterIdentifier_example; // The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
String *deferMaintenance = deferMaintenance_example; // A boolean indicating whether to enable the deferred maintenance window. (optional)
String *deferMaintenanceDuration = deferMaintenanceDuration_example; // An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less. (optional)
String *deferMaintenanceEndTime = deferMaintenanceEndTime_example; // A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration. (optional)
String *deferMaintenanceIdentifier = deferMaintenanceIdentifier_example; // A unique identifier for the deferred maintenance window. (optional)

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

[apiInstance modifyClusterMaintenanceWith:clusterIdentifier
    deferMaintenance:deferMaintenance
    deferMaintenanceDuration:deferMaintenanceDuration
    deferMaintenanceEndTime:deferMaintenanceEndTime
    deferMaintenanceIdentifier:deferMaintenanceIdentifier
              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_.ModifyClusterMaintenanceApi()

var clusterIdentifier = clusterIdentifier_example; // {String} The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r

var opts = { 
  'deferMaintenance': deferMaintenance_example, // {String} A boolean indicating whether to enable the deferred maintenance window.
  'deferMaintenanceDuration': deferMaintenanceDuration_example, // {String} An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less.
  'deferMaintenanceEndTime': deferMaintenanceEndTime_example, // {String} A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration.
  'deferMaintenanceIdentifier': deferMaintenanceIdentifier_example // {String} A unique identifier for the deferred maintenance window.
};

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

namespace Example
{
    public class modifyClusterMaintenanceExample
    {
        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 ModifyClusterMaintenanceApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
            var deferMaintenance = deferMaintenance_example;  // String | A boolean indicating whether to enable the deferred maintenance window. (optional) 
            var deferMaintenanceDuration = deferMaintenanceDuration_example;  // String | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less. (optional) 
            var deferMaintenanceEndTime = deferMaintenanceEndTime_example;  // String | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration. (optional) 
            var deferMaintenanceIdentifier = deferMaintenanceIdentifier_example;  // String | A unique identifier for the deferred maintenance window. (optional) 

            try
            {
                inline_response_200_7 result = apiInstance.modifyClusterMaintenance(clusterIdentifier, deferMaintenance, deferMaintenanceDuration, deferMaintenanceEndTime, deferMaintenanceIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterMaintenanceApi.modifyClusterMaintenance: " + 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\ModifyClusterMaintenanceApi();
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
$deferMaintenance = deferMaintenance_example; // String | A boolean indicating whether to enable the deferred maintenance window.
$deferMaintenanceDuration = deferMaintenanceDuration_example; // String | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less.
$deferMaintenanceEndTime = deferMaintenanceEndTime_example; // String | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration.
$deferMaintenanceIdentifier = deferMaintenanceIdentifier_example; // String | A unique identifier for the deferred maintenance window.

try {
    $result = $api_instance->modifyClusterMaintenance($clusterIdentifier, $deferMaintenance, $deferMaintenanceDuration, $deferMaintenanceEndTime, $deferMaintenanceIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModifyClusterMaintenanceApi->modifyClusterMaintenance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModifyClusterMaintenanceApi;

# 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::ModifyClusterMaintenanceApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
my $deferMaintenance = deferMaintenance_example; # String | A boolean indicating whether to enable the deferred maintenance window.
my $deferMaintenanceDuration = deferMaintenanceDuration_example; # String | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less.
my $deferMaintenanceEndTime = deferMaintenanceEndTime_example; # String | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration.
my $deferMaintenanceIdentifier = deferMaintenanceIdentifier_example; # String | A unique identifier for the deferred maintenance window.

eval { 
    my $result = $api_instance->modifyClusterMaintenance(clusterIdentifier => $clusterIdentifier, deferMaintenance => $deferMaintenance, deferMaintenanceDuration => $deferMaintenanceDuration, deferMaintenanceEndTime => $deferMaintenanceEndTime, deferMaintenanceIdentifier => $deferMaintenanceIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterMaintenanceApi->modifyClusterMaintenance: $@\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.ModifyClusterMaintenanceApi()
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
deferMaintenance = deferMaintenance_example # String | A boolean indicating whether to enable the deferred maintenance window. (optional)
deferMaintenanceDuration = deferMaintenanceDuration_example # String | An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less. (optional)
deferMaintenanceEndTime = deferMaintenanceEndTime_example # String | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration. (optional)
deferMaintenanceIdentifier = deferMaintenanceIdentifier_example # String | A unique identifier for the deferred maintenance window. (optional)

try: 
    api_response = api_instance.modify_cluster_maintenance(clusterIdentifier, deferMaintenance=deferMaintenance, deferMaintenanceDuration=deferMaintenanceDuration, deferMaintenanceEndTime=deferMaintenanceEndTime, deferMaintenanceIdentifier=deferMaintenanceIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterMaintenanceApi->modifyClusterMaintenance: %s\n" % e)

Parameters

Query parameters
Name Description
ClusterIdentifier*
String
The unique identifier of the cluster for which you want to associate or disassociate IAM roles.r
Required
DeferMaintenance
String
A boolean indicating whether to enable the deferred maintenance window.
DeferMaintenanceDuration
String
An integer indicating the duration of the maintenance window in days. If you specify a duration, you can`t specify an end time. The duration must be 45 days or less.
DeferMaintenanceEndTime
String
A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can`t specify a duration.
DeferMaintenanceIdentifier
String
A unique identifier for the deferred maintenance window.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyClusterParameterGroup

modifyClusterParameterGroup

Modifies the parameters of a parameter group.


/ModifyClusterParameterGroup

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/ModifyClusterParameterGroup?ParameterGroupName=&Parameters.Parameter.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModifyClusterParameterGroupApi;

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

public class ModifyClusterParameterGroupApiExample {

    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");

        ModifyClusterParameterGroupApi apiInstance = new ModifyClusterParameterGroupApi();
        String parameterGroupName = parameterGroupName_example; // String | The name of the parameter group to be modified.
        array[String] parameters.Parameter.N = ; // array[String] | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
        try {
            inline_response_200_48 result = apiInstance.modifyClusterParameterGroup(parameterGroupName, parameters.Parameter.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterParameterGroupApi#modifyClusterParameterGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterParameterGroupApi;

public class ModifyClusterParameterGroupApiExample {

    public static void main(String[] args) {
        ModifyClusterParameterGroupApi apiInstance = new ModifyClusterParameterGroupApi();
        String parameterGroupName = parameterGroupName_example; // String | The name of the parameter group to be modified.
        array[String] parameters.Parameter.N = ; // array[String] | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
        try {
            inline_response_200_48 result = apiInstance.modifyClusterParameterGroup(parameterGroupName, parameters.Parameter.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterParameterGroupApi#modifyClusterParameterGroup");
            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 *parameterGroupName = parameterGroupName_example; // The name of the parameter group to be modified.
array[String] *parameters.Parameter.N = ; // An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. (optional)

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

[apiInstance modifyClusterParameterGroupWith:parameterGroupName
    parameters.Parameter.N:parameters.Parameter.N
              completionHandler: ^(inline_response_200_48 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_.ModifyClusterParameterGroupApi()

var parameterGroupName = parameterGroupName_example; // {String} The name of the parameter group to be modified.

var opts = { 
  'parameters.Parameter.N':  // {array[String]} An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
};

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

namespace Example
{
    public class modifyClusterParameterGroupExample
    {
        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 ModifyClusterParameterGroupApi();
            var parameterGroupName = parameterGroupName_example;  // String | The name of the parameter group to be modified.
            var parameters.Parameter.N = new array[String](); // array[String] | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. (optional) 

            try
            {
                inline_response_200_48 result = apiInstance.modifyClusterParameterGroup(parameterGroupName, parameters.Parameter.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterParameterGroupApi.modifyClusterParameterGroup: " + 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\ModifyClusterParameterGroupApi();
$parameterGroupName = parameterGroupName_example; // String | The name of the parameter group to be modified.
$parameters.Parameter.N = ; // array[String] | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

try {
    $result = $api_instance->modifyClusterParameterGroup($parameterGroupName, $parameters.Parameter.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModifyClusterParameterGroupApi->modifyClusterParameterGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModifyClusterParameterGroupApi;

# 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::ModifyClusterParameterGroupApi->new();
my $parameterGroupName = parameterGroupName_example; # String | The name of the parameter group to be modified.
my $parameters.Parameter.N = []; # array[String] | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

eval { 
    my $result = $api_instance->modifyClusterParameterGroup(parameterGroupName => $parameterGroupName, parameters.Parameter.N => $parameters.Parameter.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterParameterGroupApi->modifyClusterParameterGroup: $@\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.ModifyClusterParameterGroupApi()
parameterGroupName = parameterGroupName_example # String | The name of the parameter group to be modified.
parameters.Parameter.N =  # array[String] | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. (optional)

try: 
    api_response = api_instance.modify_cluster_parameter_group(parameterGroupName, parameters.Parameter.N=parameters.Parameter.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterParameterGroupApi->modifyClusterParameterGroup: %s\n" % e)

Parameters

Query parameters
Name Description
ParameterGroupName*
String
The name of the parameter group to be modified.
Required
Parameters.Parameter.N
array[String]
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyClusterSnapshot

modifyClusterSnapshot

Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot.


/ModifyClusterSnapshot

Usage and SDK Samples

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

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

public class ModifyClusterSnapshotApiExample {

    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");

        ModifyClusterSnapshotApi apiInstance = new ModifyClusterSnapshotApi();
        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot whose setting you want to modify.
        array[Boolean] force = ; // array[Boolean] | A Boolean option to override an exception if the retention period has already passed.
        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.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.
        try {
            inline_response_200_48 result = apiInstance.modifyClusterSnapshot(snapshotIdentifier, force, manualSnapshotRetentionPeriod);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterSnapshotApi#modifyClusterSnapshot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterSnapshotApi;

public class ModifyClusterSnapshotApiExample {

    public static void main(String[] args) {
        ModifyClusterSnapshotApi apiInstance = new ModifyClusterSnapshotApi();
        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot whose setting you want to modify.
        array[Boolean] force = ; // array[Boolean] | A Boolean option to override an exception if the retention period has already passed.
        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.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.
        try {
            inline_response_200_48 result = apiInstance.modifyClusterSnapshot(snapshotIdentifier, force, manualSnapshotRetentionPeriod);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterSnapshotApi#modifyClusterSnapshot");
            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 *snapshotIdentifier = snapshotIdentifier_example; // The identifier of the snapshot whose setting you want to modify.
array[Boolean] *force = ; // A Boolean option to override an exception if the retention period has already passed. (optional)
Integer *manualSnapshotRetentionPeriod = 56; // The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653. (optional)

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

[apiInstance modifyClusterSnapshotWith:snapshotIdentifier
    force:force
    manualSnapshotRetentionPeriod:manualSnapshotRetentionPeriod
              completionHandler: ^(inline_response_200_48 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_.ModifyClusterSnapshotApi()

var snapshotIdentifier = snapshotIdentifier_example; // {String} The identifier of the snapshot whose setting you want to modify.

var opts = { 
  'force': , // {array[Boolean]} A Boolean option to override an exception if the retention period has already passed.
  'manualSnapshotRetentionPeriod': 56 // {Integer} The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.
};

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

namespace Example
{
    public class modifyClusterSnapshotExample
    {
        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 ModifyClusterSnapshotApi();
            var snapshotIdentifier = snapshotIdentifier_example;  // String | The identifier of the snapshot whose setting you want to modify.
            var force = new array[Boolean](); // array[Boolean] | A Boolean option to override an exception if the retention period has already passed. (optional) 
            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.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653. (optional) 

            try
            {
                inline_response_200_48 result = apiInstance.modifyClusterSnapshot(snapshotIdentifier, force, manualSnapshotRetentionPeriod);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterSnapshotApi.modifyClusterSnapshot: " + 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\ModifyClusterSnapshotApi();
$snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot whose setting you want to modify.
$force = ; // array[Boolean] | A Boolean option to override an exception if the retention period has already passed.
$manualSnapshotRetentionPeriod = 56; // Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.

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

# 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::ModifyClusterSnapshotApi->new();
my $snapshotIdentifier = snapshotIdentifier_example; # String | The identifier of the snapshot whose setting you want to modify.
my $force = []; # array[Boolean] | A Boolean option to override an exception if the retention period has already passed.
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.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.

eval { 
    my $result = $api_instance->modifyClusterSnapshot(snapshotIdentifier => $snapshotIdentifier, force => $force, manualSnapshotRetentionPeriod => $manualSnapshotRetentionPeriod);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterSnapshotApi->modifyClusterSnapshot: $@\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.ModifyClusterSnapshotApi()
snapshotIdentifier = snapshotIdentifier_example # String | The identifier of the snapshot whose setting you want to modify.
force =  # array[Boolean] | A Boolean option to override an exception if the retention period has already passed. (optional)
manualSnapshotRetentionPeriod = 56 # Integer | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653. (optional)

try: 
    api_response = api_instance.modify_cluster_snapshot(snapshotIdentifier, force=force, manualSnapshotRetentionPeriod=manualSnapshotRetentionPeriod)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterSnapshotApi->modifyClusterSnapshot: %s\n" % e)

Parameters

Query parameters
Name Description
SnapshotIdentifier*
String
The identifier of the snapshot whose setting you want to modify.
Required
Force
array[Boolean]
A Boolean option to override an exception if the retention period has already passed.
ManualSnapshotRetentionPeriod
Integer
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot. The value must be either -1 or an integer between 1 and 3,653.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyClusterSnapshotSchedule

modifyClusterSnapshotSchedule

Modifies a snapshot schedule for a cluster.


/ModifyClusterSnapshotSchedule

Usage and SDK Samples

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

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

public class ModifyClusterSnapshotScheduleApiExample {

    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");

        ModifyClusterSnapshotScheduleApi apiInstance = new ModifyClusterSnapshotScheduleApi();
        String clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for the cluster whose snapshot schedule you want to modify.
        Boolean disassociateSchedule = true; // Boolean | A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
        Integer scheduleIdentifier = 56; // Integer | TA unique alphanumeric identifier for the schedule that you want to associate with the cluster.
        try {
            inline_response_200_17 result = apiInstance.modifyClusterSnapshotSchedule(clusterIdentifier, disassociateSchedule, scheduleIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterSnapshotScheduleApi#modifyClusterSnapshotSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterSnapshotScheduleApi;

public class ModifyClusterSnapshotScheduleApiExample {

    public static void main(String[] args) {
        ModifyClusterSnapshotScheduleApi apiInstance = new ModifyClusterSnapshotScheduleApi();
        String clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for the cluster whose snapshot schedule you want to modify.
        Boolean disassociateSchedule = true; // Boolean | A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
        Integer scheduleIdentifier = 56; // Integer | TA unique alphanumeric identifier for the schedule that you want to associate with the cluster.
        try {
            inline_response_200_17 result = apiInstance.modifyClusterSnapshotSchedule(clusterIdentifier, disassociateSchedule, scheduleIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterSnapshotScheduleApi#modifyClusterSnapshotSchedule");
            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 *clusterIdentifier = clusterIdentifier_example; // A unique identifier for the cluster whose snapshot schedule you want to modify.
Boolean *disassociateSchedule = true; // A boolean to indicate whether to remove the assoiciation between the cluster and the schedule. (optional)
Integer *scheduleIdentifier = 56; // TA unique alphanumeric identifier for the schedule that you want to associate with the cluster. (optional)

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

[apiInstance modifyClusterSnapshotScheduleWith:clusterIdentifier
    disassociateSchedule:disassociateSchedule
    scheduleIdentifier:scheduleIdentifier
              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_.ModifyClusterSnapshotScheduleApi()

var clusterIdentifier = clusterIdentifier_example; // {String} A unique identifier for the cluster whose snapshot schedule you want to modify.

var opts = { 
  'disassociateSchedule': true, // {Boolean} A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
  'scheduleIdentifier': 56 // {Integer} TA unique alphanumeric identifier for the schedule that you want to associate with the cluster.
};

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

namespace Example
{
    public class modifyClusterSnapshotScheduleExample
    {
        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 ModifyClusterSnapshotScheduleApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | A unique identifier for the cluster whose snapshot schedule you want to modify.
            var disassociateSchedule = true;  // Boolean | A boolean to indicate whether to remove the assoiciation between the cluster and the schedule. (optional) 
            var scheduleIdentifier = 56;  // Integer | TA unique alphanumeric identifier for the schedule that you want to associate with the cluster. (optional) 

            try
            {
                inline_response_200_17 result = apiInstance.modifyClusterSnapshotSchedule(clusterIdentifier, disassociateSchedule, scheduleIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterSnapshotScheduleApi.modifyClusterSnapshotSchedule: " + 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\ModifyClusterSnapshotScheduleApi();
$clusterIdentifier = clusterIdentifier_example; // String | A unique identifier for the cluster whose snapshot schedule you want to modify.
$disassociateSchedule = true; // Boolean | A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
$scheduleIdentifier = 56; // Integer | TA unique alphanumeric identifier for the schedule that you want to associate with the cluster.

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

# 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::ModifyClusterSnapshotScheduleApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | A unique identifier for the cluster whose snapshot schedule you want to modify.
my $disassociateSchedule = true; # Boolean | A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
my $scheduleIdentifier = 56; # Integer | TA unique alphanumeric identifier for the schedule that you want to associate with the cluster.

eval { 
    my $result = $api_instance->modifyClusterSnapshotSchedule(clusterIdentifier => $clusterIdentifier, disassociateSchedule => $disassociateSchedule, scheduleIdentifier => $scheduleIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterSnapshotScheduleApi->modifyClusterSnapshotSchedule: $@\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.ModifyClusterSnapshotScheduleApi()
clusterIdentifier = clusterIdentifier_example # String | A unique identifier for the cluster whose snapshot schedule you want to modify.
disassociateSchedule = true # Boolean | A boolean to indicate whether to remove the assoiciation between the cluster and the schedule. (optional)
scheduleIdentifier = 56 # Integer | TA unique alphanumeric identifier for the schedule that you want to associate with the cluster. (optional)

try: 
    api_response = api_instance.modify_cluster_snapshot_schedule(clusterIdentifier, disassociateSchedule=disassociateSchedule, scheduleIdentifier=scheduleIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterSnapshotScheduleApi->modifyClusterSnapshotSchedule: %s\n" % e)

Parameters

Query parameters
Name Description
ClusterIdentifier*
String
A unique identifier for the cluster whose snapshot schedule you want to modify.
Required
DisassociateSchedule
Boolean
A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
ScheduleIdentifier
Integer
TA unique alphanumeric identifier for the schedule that you want to associate with the cluster.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyClusterSubnetGroup

modifyClusterSubnetGroup

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.


/ModifyClusterSubnetGroup

Usage and SDK Samples

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

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

public class ModifyClusterSubnetGroupApiExample {

    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");

        ModifyClusterSubnetGroupApi apiInstance = new ModifyClusterSubnetGroupApi();
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the subnet group to be modified.
        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.
        Integer description = 56; // Integer | A text description of the subnet group to be modified.
        try {
            inline_response_200_10 result = apiInstance.modifyClusterSubnetGroup(clusterSubnetGroupName, subnetIds.SubnetIdentifier.N, description);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterSubnetGroupApi#modifyClusterSubnetGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyClusterSubnetGroupApi;

public class ModifyClusterSubnetGroupApiExample {

    public static void main(String[] args) {
        ModifyClusterSubnetGroupApi apiInstance = new ModifyClusterSubnetGroupApi();
        String clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the subnet group to be modified.
        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.
        Integer description = 56; // Integer | A text description of the subnet group to be modified.
        try {
            inline_response_200_10 result = apiInstance.modifyClusterSubnetGroup(clusterSubnetGroupName, subnetIds.SubnetIdentifier.N, description);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyClusterSubnetGroupApi#modifyClusterSubnetGroup");
            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 *clusterSubnetGroupName = clusterSubnetGroupName_example; // The name of the subnet group to be modified.
array[String] *subnetIds.SubnetIdentifier.N = ; // An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
Integer *description = 56; // A text description of the subnet group to be modified. (optional)

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

[apiInstance modifyClusterSubnetGroupWith:clusterSubnetGroupName
    subnetIds.SubnetIdentifier.N:subnetIds.SubnetIdentifier.N
    description:description
              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_.ModifyClusterSubnetGroupApi()

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

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 = { 
  'description': 56 // {Integer} A text description of the subnet group to be modified.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyClusterSubnetGroup(clusterSubnetGroupName, 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 modifyClusterSubnetGroupExample
    {
        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 ModifyClusterSubnetGroupApi();
            var clusterSubnetGroupName = clusterSubnetGroupName_example;  // String | The name of the subnet group to be modified.
            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 description = 56;  // Integer | A text description of the subnet group to be modified. (optional) 

            try
            {
                inline_response_200_10 result = apiInstance.modifyClusterSubnetGroup(clusterSubnetGroupName, subnetIds.SubnetIdentifier.N, description);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyClusterSubnetGroupApi.modifyClusterSubnetGroup: " + 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\ModifyClusterSubnetGroupApi();
$clusterSubnetGroupName = clusterSubnetGroupName_example; // String | The name of the subnet group to be modified.
$subnetIds.SubnetIdentifier.N = ; // array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
$description = 56; // Integer | A text description of the subnet group to be modified.

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

# 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::ModifyClusterSubnetGroupApi->new();
my $clusterSubnetGroupName = clusterSubnetGroupName_example; # String | The name of the subnet group to be modified.
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 $description = 56; # Integer | A text description of the subnet group to be modified.

eval { 
    my $result = $api_instance->modifyClusterSubnetGroup(clusterSubnetGroupName => $clusterSubnetGroupName, subnetIds.SubnetIdentifier.N => $subnetIds.SubnetIdentifier.N, description => $description);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyClusterSubnetGroupApi->modifyClusterSubnetGroup: $@\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.ModifyClusterSubnetGroupApi()
clusterSubnetGroupName = clusterSubnetGroupName_example # String | The name of the subnet group to be modified.
subnetIds.SubnetIdentifier.N =  # array[String] | An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
description = 56 # Integer | A text description of the subnet group to be modified. (optional)

try: 
    api_response = api_instance.modify_cluster_subnet_group(clusterSubnetGroupName, subnetIds.SubnetIdentifier.N, description=description)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyClusterSubnetGroupApi->modifyClusterSubnetGroup: %s\n" % e)

Parameters

Query parameters
Name Description
ClusterSubnetGroupName*
String
The name of the subnet group to be modified.
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
Description
Integer
A text description of the subnet group to be modified.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyEventSubscription

modifyEventSubscription

Modifies an existing Amazon Redshift event notification subscription.


/ModifyEventSubscription

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/ModifyEventSubscription?SubscriptionName=&Enabled=&EventCategories.EventCategory.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModifyEventSubscriptionApi;

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

public class ModifyEventSubscriptionApiExample {

    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");

        ModifyEventSubscriptionApi apiInstance = new ModifyEventSubscriptionApi();
        String subscriptionName = subscriptionName_example; // String | The name of the modified Amazon Redshift event notification subscription.
        Boolean enabled = true; // Boolean | A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
        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
        try {
            inline_response_200_49 result = apiInstance.modifyEventSubscription(subscriptionName, enabled, eventCategories.EventCategory.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyEventSubscriptionApi#modifyEventSubscription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyEventSubscriptionApi;

public class ModifyEventSubscriptionApiExample {

    public static void main(String[] args) {
        ModifyEventSubscriptionApi apiInstance = new ModifyEventSubscriptionApi();
        String subscriptionName = subscriptionName_example; // String | The name of the modified Amazon Redshift event notification subscription.
        Boolean enabled = true; // Boolean | A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
        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
        try {
            inline_response_200_49 result = apiInstance.modifyEventSubscription(subscriptionName, enabled, eventCategories.EventCategory.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyEventSubscriptionApi#modifyEventSubscription");
            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 *subscriptionName = subscriptionName_example; // The name of the modified Amazon Redshift event notification subscription.
Boolean *enabled = true; // A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
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)

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

[apiInstance modifyEventSubscriptionWith:subscriptionName
    enabled:enabled
    eventCategories.EventCategory.N:eventCategories.EventCategory.N
              completionHandler: ^(inline_response_200_49 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_.ModifyEventSubscriptionApi()

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

var enabled = true; // {Boolean} A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.

var opts = { 
  'eventCategories.EventCategory.N':  // {array[String]} Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security
};

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

namespace Example
{
    public class modifyEventSubscriptionExample
    {
        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 ModifyEventSubscriptionApi();
            var subscriptionName = subscriptionName_example;  // String | The name of the modified Amazon Redshift event notification subscription.
            var enabled = true;  // Boolean | A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
            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) 

            try
            {
                inline_response_200_49 result = apiInstance.modifyEventSubscription(subscriptionName, enabled, eventCategories.EventCategory.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyEventSubscriptionApi.modifyEventSubscription: " + 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\ModifyEventSubscriptionApi();
$subscriptionName = subscriptionName_example; // String | The name of the modified Amazon Redshift event notification subscription.
$enabled = true; // Boolean | A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
$eventCategories.EventCategory.N = ; // array[String] | Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security

try {
    $result = $api_instance->modifyEventSubscription($subscriptionName, $enabled, $eventCategories.EventCategory.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModifyEventSubscriptionApi->modifyEventSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModifyEventSubscriptionApi;

# 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::ModifyEventSubscriptionApi->new();
my $subscriptionName = subscriptionName_example; # String | The name of the modified Amazon Redshift event notification subscription.
my $enabled = true; # Boolean | A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
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

eval { 
    my $result = $api_instance->modifyEventSubscription(subscriptionName => $subscriptionName, enabled => $enabled, eventCategories.EventCategory.N => $eventCategories.EventCategory.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyEventSubscriptionApi->modifyEventSubscription: $@\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.ModifyEventSubscriptionApi()
subscriptionName = subscriptionName_example # String | The name of the modified Amazon Redshift event notification subscription.
enabled = true # Boolean | A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
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)

try: 
    api_response = api_instance.modify_event_subscription(subscriptionName, enabled, eventCategories.EventCategory.N=eventCategories.EventCategory.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyEventSubscriptionApi->modifyEventSubscription: %s\n" % e)

Parameters

Query parameters
Name Description
SubscriptionName*
String
The name of the modified Amazon Redshift event notification subscription.
Required
Enabled*
Boolean
A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled.
Required
EventCategories.EventCategory.N
array[String]
Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifyScheduledAction

modifyScheduledAction

MModifies a scheduled action.


/ModifyScheduledAction

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/ModifyScheduledAction?Active=&EndTime=&Filters.ScheduledActionFilter.N=&ScheduledActionName=&Marker=&MaxRecords="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModifyScheduledActionApi;

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

public class ModifyScheduledActionApiExample {

    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");

        ModifyScheduledActionApi apiInstance = new ModifyScheduledActionApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean active = true; // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
        String endTime = endTime_example; // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
        array[String] filters.ScheduledActionFilter.N = ; // array[String] | List of scheduled action filters.
        Boolean scheduledActionName = true; // Boolean | The name of the scheduled action to retrieve..
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_39 result = apiInstance.modifyScheduledAction(apiecoKey, active, endTime, filters.ScheduledActionFilter.N, scheduledActionName, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyScheduledActionApi#modifyScheduledAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifyScheduledActionApi;

public class ModifyScheduledActionApiExample {

    public static void main(String[] args) {
        ModifyScheduledActionApi apiInstance = new ModifyScheduledActionApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean active = true; // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
        String endTime = endTime_example; // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
        array[String] filters.ScheduledActionFilter.N = ; // array[String] | List of scheduled action filters.
        Boolean scheduledActionName = true; // Boolean | The name of the scheduled action to retrieve..
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        try {
            inline_response_200_39 result = apiInstance.modifyScheduledAction(apiecoKey, active, endTime, filters.ScheduledActionFilter.N, scheduledActionName, marker, maxRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifyScheduledActionApi#modifyScheduledAction");
            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 *active = true; // If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. (optional)
String *endTime = endTime_example; // The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. (optional)
array[String] *filters.ScheduledActionFilter.N = ; // List of scheduled action filters. (optional)
Boolean *scheduledActionName = true; // The name of the scheduled action to retrieve.. (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

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

[apiInstance modifyScheduledActionWith:apiecoKey
    active:active
    endTime:endTime
    filters.ScheduledActionFilter.N:filters.ScheduledActionFilter.N
    scheduledActionName:scheduledActionName
    marker:marker
    maxRecords:maxRecords
              completionHandler: ^(inline_response_200_39 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_.ModifyScheduledActionApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'active': true, // {Boolean} If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
  'endTime': endTime_example, // {String} The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
  'filters.ScheduledActionFilter.N': , // {array[String]} List of scheduled action filters.
  'scheduledActionName': true, // {Boolean} The name of the scheduled action to retrieve..
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'maxRecords': 8.14 // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
};

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

namespace Example
{
    public class modifyScheduledActionExample
    {
        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 ModifyScheduledActionApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var active = true;  // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. (optional) 
            var endTime = endTime_example;  // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. (optional) 
            var filters.ScheduledActionFilter.N = new array[String](); // array[String] | List of scheduled action filters. (optional) 
            var scheduledActionName = true;  // Boolean | The name of the scheduled action to retrieve.. (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 

            try
            {
                inline_response_200_39 result = apiInstance.modifyScheduledAction(apiecoKey, active, endTime, filters.ScheduledActionFilter.N, scheduledActionName, marker, maxRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifyScheduledActionApi.modifyScheduledAction: " + 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\ModifyScheduledActionApi();
$apiecoKey = apiecoKey_example; // String | 
$active = true; // Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
$endTime = endTime_example; // String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
$filters.ScheduledActionFilter.N = ; // array[String] | List of scheduled action filters.
$scheduledActionName = true; // Boolean | The name of the scheduled action to retrieve..
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

try {
    $result = $api_instance->modifyScheduledAction($apiecoKey, $active, $endTime, $filters.ScheduledActionFilter.N, $scheduledActionName, $marker, $maxRecords);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModifyScheduledActionApi->modifyScheduledAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModifyScheduledActionApi;

# 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::ModifyScheduledActionApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $active = true; # Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
my $endTime = endTime_example; # String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
my $filters.ScheduledActionFilter.N = []; # array[String] | List of scheduled action filters.
my $scheduledActionName = true; # Boolean | The name of the scheduled action to retrieve..
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.

eval { 
    my $result = $api_instance->modifyScheduledAction(apiecoKey => $apiecoKey, active => $active, endTime => $endTime, filters.ScheduledActionFilter.N => $filters.ScheduledActionFilter.N, scheduledActionName => $scheduledActionName, marker => $marker, maxRecords => $maxRecords);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifyScheduledActionApi->modifyScheduledAction: $@\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.ModifyScheduledActionApi()
apiecoKey = apiecoKey_example # String | 
active = true # Boolean | If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. (optional)
endTime = endTime_example # String | The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved. (optional)
filters.ScheduledActionFilter.N =  # array[String] | List of scheduled action filters. (optional)
scheduledActionName = true # Boolean | The name of the scheduled action to retrieve.. (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)

try: 
    api_response = api_instance.modify_scheduled_action(apiecoKey, active=active, endTime=endTime, filters.ScheduledActionFilter.N=filters.ScheduledActionFilter.N, scheduledActionName=scheduledActionName, marker=marker, maxRecords=maxRecords)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifyScheduledActionApi->modifyScheduledAction: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
Active
Boolean
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
EndTime
String
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
Filters.ScheduledActionFilter.N
array[String]
List of scheduled action filters.
ScheduledActionName
Boolean
The name of the scheduled action to retrieve..
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifySnapshotCopyRetentionPeriod

modifySnapshotCopyRetentionPeriod

Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.


/ModifySnapshotCopyRetentionPeriod

Usage and SDK Samples

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

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

public class ModifySnapshotCopyRetentionPeriodApiExample {

    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");

        ModifySnapshotCopyRetentionPeriodApi apiInstance = new ModifySnapshotCopyRetentionPeriodApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer retentionPeriod = 56; // Integer | TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled..
        Boolean manual = true; // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
        try {
            inline_response_200_50 result = apiInstance.modifySnapshotCopyRetentionPeriod(apiecoKey, retentionPeriod, clusterIdentifier, manual);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifySnapshotCopyRetentionPeriodApi#modifySnapshotCopyRetentionPeriod");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifySnapshotCopyRetentionPeriodApi;

public class ModifySnapshotCopyRetentionPeriodApiExample {

    public static void main(String[] args) {
        ModifySnapshotCopyRetentionPeriodApi apiInstance = new ModifySnapshotCopyRetentionPeriodApi();
        String apiecoKey = apiecoKey_example; // String | 
        Integer retentionPeriod = 56; // Integer | TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled..
        Boolean manual = true; // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
        try {
            inline_response_200_50 result = apiInstance.modifySnapshotCopyRetentionPeriod(apiecoKey, retentionPeriod, clusterIdentifier, manual);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifySnapshotCopyRetentionPeriodApi#modifySnapshotCopyRetentionPeriod");
            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; // 
Integer *retentionPeriod = 56; // TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
String *clusterIdentifier = clusterIdentifier_example; // The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.. (optional)
Boolean *manual = true; // Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. (optional)

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

[apiInstance modifySnapshotCopyRetentionPeriodWith:apiecoKey
    retentionPeriod:retentionPeriod
    clusterIdentifier:clusterIdentifier
    manual:manual
              completionHandler: ^(inline_response_200_50 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_.ModifySnapshotCopyRetentionPeriodApi()

var apiecoKey = apiecoKey_example; // {String} 

var retentionPeriod = 56; // {Integer} TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

var opts = { 
  'clusterIdentifier': clusterIdentifier_example, // {String} The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled..
  'manual': true // {Boolean} Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
};

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

namespace Example
{
    public class modifySnapshotCopyRetentionPeriodExample
    {
        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 ModifySnapshotCopyRetentionPeriodApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var retentionPeriod = 56;  // Integer | TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.. (optional) 
            var manual = true;  // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. (optional) 

            try
            {
                inline_response_200_50 result = apiInstance.modifySnapshotCopyRetentionPeriod(apiecoKey, retentionPeriod, clusterIdentifier, manual);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifySnapshotCopyRetentionPeriodApi.modifySnapshotCopyRetentionPeriod: " + 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\ModifySnapshotCopyRetentionPeriodApi();
$apiecoKey = apiecoKey_example; // String | 
$retentionPeriod = 56; // Integer | TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled..
$manual = true; // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

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

# 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::ModifySnapshotCopyRetentionPeriodApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $retentionPeriod = 56; # Integer | TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled..
my $manual = true; # Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

eval { 
    my $result = $api_instance->modifySnapshotCopyRetentionPeriod(apiecoKey => $apiecoKey, retentionPeriod => $retentionPeriod, clusterIdentifier => $clusterIdentifier, manual => $manual);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifySnapshotCopyRetentionPeriodApi->modifySnapshotCopyRetentionPeriod: $@\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.ModifySnapshotCopyRetentionPeriodApi()
apiecoKey = apiecoKey_example # String | 
retentionPeriod = 56 # Integer | TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.. (optional)
manual = true # Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. (optional)

try: 
    api_response = api_instance.modify_snapshot_copy_retention_period(apiecoKey, retentionPeriod, clusterIdentifier=clusterIdentifier, manual=manual)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifySnapshotCopyRetentionPeriodApi->modifySnapshotCopyRetentionPeriod: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
String
The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled..
RetentionPeriod*
Integer
TThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this only changes the retention period of copied automated snapshots. If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35 for automated snapshots. If you specify the manual option, only newly copied manual snapshots will have the new retention period. If you specify the value of -1 newly copied manual snapshots are retained indefinitely. Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
Required
Manual
Boolean
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ModifySnapshotSchedule

modifySnapshotSchedule

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.


/ModifySnapshotSchedule

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/ModifySnapshotSchedule?ScheduleDefinitions.ScheduleDefinition.N=&ScheduleIdentifier=&Manual="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModifySnapshotScheduleApi;

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

public class ModifySnapshotScheduleApiExample {

    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");

        ModifySnapshotScheduleApi apiInstance = new ModifySnapshotScheduleApi();
        String apiecoKey = apiecoKey_example; // String | 
        String scheduleIdentifier = scheduleIdentifier_example; // String | A unique alphanumeric identifier of the schedule to modify.
        array[String] scheduleDefinitions.ScheduleDefinition.N = ; // array[String] | An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
        Boolean manual = true; // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
        try {
            inline_response_200_51 result = apiInstance.modifySnapshotSchedule(apiecoKey, scheduleIdentifier, scheduleDefinitions.ScheduleDefinition.N, manual);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifySnapshotScheduleApi#modifySnapshotSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModifySnapshotScheduleApi;

public class ModifySnapshotScheduleApiExample {

    public static void main(String[] args) {
        ModifySnapshotScheduleApi apiInstance = new ModifySnapshotScheduleApi();
        String apiecoKey = apiecoKey_example; // String | 
        String scheduleIdentifier = scheduleIdentifier_example; // String | A unique alphanumeric identifier of the schedule to modify.
        array[String] scheduleDefinitions.ScheduleDefinition.N = ; // array[String] | An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
        Boolean manual = true; // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
        try {
            inline_response_200_51 result = apiInstance.modifySnapshotSchedule(apiecoKey, scheduleIdentifier, scheduleDefinitions.ScheduleDefinition.N, manual);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModifySnapshotScheduleApi#modifySnapshotSchedule");
            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 *scheduleIdentifier = scheduleIdentifier_example; // A unique alphanumeric identifier of the schedule to modify.
array[String] *scheduleDefinitions.ScheduleDefinition.N = ; // An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)". (optional)
Boolean *manual = true; // Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. (optional)

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

[apiInstance modifySnapshotScheduleWith:apiecoKey
    scheduleIdentifier:scheduleIdentifier
    scheduleDefinitions.ScheduleDefinition.N:scheduleDefinitions.ScheduleDefinition.N
    manual:manual
              completionHandler: ^(inline_response_200_51 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_.ModifySnapshotScheduleApi()

var apiecoKey = apiecoKey_example; // {String} 

var scheduleIdentifier = scheduleIdentifier_example; // {String} A unique alphanumeric identifier of the schedule to modify.

var opts = { 
  'scheduleDefinitions.ScheduleDefinition.N': , // {array[String]} An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
  'manual': true // {Boolean} Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
};

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

namespace Example
{
    public class modifySnapshotScheduleExample
    {
        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 ModifySnapshotScheduleApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var scheduleIdentifier = scheduleIdentifier_example;  // String | A unique alphanumeric identifier of the schedule to modify.
            var scheduleDefinitions.ScheduleDefinition.N = new array[String](); // array[String] | An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)". (optional) 
            var manual = true;  // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. (optional) 

            try
            {
                inline_response_200_51 result = apiInstance.modifySnapshotSchedule(apiecoKey, scheduleIdentifier, scheduleDefinitions.ScheduleDefinition.N, manual);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModifySnapshotScheduleApi.modifySnapshotSchedule: " + 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\ModifySnapshotScheduleApi();
$apiecoKey = apiecoKey_example; // String | 
$scheduleIdentifier = scheduleIdentifier_example; // String | A unique alphanumeric identifier of the schedule to modify.
$scheduleDefinitions.ScheduleDefinition.N = ; // array[String] | An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
$manual = true; // Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

try {
    $result = $api_instance->modifySnapshotSchedule($apiecoKey, $scheduleIdentifier, $scheduleDefinitions.ScheduleDefinition.N, $manual);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModifySnapshotScheduleApi->modifySnapshotSchedule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModifySnapshotScheduleApi;

# 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::ModifySnapshotScheduleApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $scheduleIdentifier = scheduleIdentifier_example; # String | A unique alphanumeric identifier of the schedule to modify.
my $scheduleDefinitions.ScheduleDefinition.N = []; # array[String] | An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
my $manual = true; # Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

eval { 
    my $result = $api_instance->modifySnapshotSchedule(apiecoKey => $apiecoKey, scheduleIdentifier => $scheduleIdentifier, scheduleDefinitions.ScheduleDefinition.N => $scheduleDefinitions.ScheduleDefinition.N, manual => $manual);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModifySnapshotScheduleApi->modifySnapshotSchedule: $@\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.ModifySnapshotScheduleApi()
apiecoKey = apiecoKey_example # String | 
scheduleIdentifier = scheduleIdentifier_example # String | A unique alphanumeric identifier of the schedule to modify.
scheduleDefinitions.ScheduleDefinition.N =  # array[String] | An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)". (optional)
manual = true # Boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. (optional)

try: 
    api_response = api_instance.modify_snapshot_schedule(apiecoKey, scheduleIdentifier, scheduleDefinitions.ScheduleDefinition.N=scheduleDefinitions.ScheduleDefinition.N, manual=manual)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModifySnapshotScheduleApi->modifySnapshotSchedule: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ScheduleDefinitions.ScheduleDefinition.N
array[String]
An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
ScheduleIdentifier*
String
A unique alphanumeric identifier of the schedule to modify.
Required
Manual
Boolean
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


PauseCluster

pauseCluster

Pauses a cluster.


/PauseCluster

Usage and SDK Samples

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

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

public class PauseClusterApiExample {

    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");

        PauseClusterApi apiInstance = new PauseClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] clusterIdentifier = ; // array[String] | The identifier of the cluster to be paused.
        try {
            inline_response_200_50 result = apiInstance.pauseCluster(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PauseClusterApi#pauseCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PauseClusterApi;

public class PauseClusterApiExample {

    public static void main(String[] args) {
        PauseClusterApi apiInstance = new PauseClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        array[String] clusterIdentifier = ; // array[String] | The identifier of the cluster to be paused.
        try {
            inline_response_200_50 result = apiInstance.pauseCluster(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PauseClusterApi#pauseCluster");
            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] *clusterIdentifier = ; // The identifier of the cluster to be paused. (optional)

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

[apiInstance pauseClusterWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_50 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_.PauseClusterApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterIdentifier':  // {array[String]} The identifier of the cluster to be paused.
};

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

namespace Example
{
    public class pauseClusterExample
    {
        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 PauseClusterApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = new array[String](); // array[String] | The identifier of the cluster to be paused. (optional) 

            try
            {
                inline_response_200_50 result = apiInstance.pauseCluster(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PauseClusterApi.pauseCluster: " + 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\PauseClusterApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = ; // array[String] | The identifier of the cluster to be paused.

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

# 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::PauseClusterApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = []; # array[String] | The identifier of the cluster to be paused.

eval { 
    my $result = $api_instance->pauseCluster(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PauseClusterApi->pauseCluster: $@\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.PauseClusterApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier =  # array[String] | The identifier of the cluster to be paused. (optional)

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier
array[String]
The identifier of the cluster to be paused.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


PurchaseReservedNodeOffering

purchaseReservedNodeOffering

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.


/PurchaseReservedNodeOffering

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/PurchaseReservedNodeOffering?ReservedNodeOfferingId=&NodeCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PurchaseReservedNodeOfferingApi;

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

public class PurchaseReservedNodeOfferingApiExample {

    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");

        PurchaseReservedNodeOfferingApi apiInstance = new PurchaseReservedNodeOfferingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeOfferingId = reservedNodeOfferingId_example; // String | The unique identifier of the reserved node offering you want to purchase.
        String nodeCount = nodeCount_example; // String | The number of reserved nodes that you want to purchase.
        try {
            inline_response_200 result = apiInstance.purchaseReservedNodeOffering(apiecoKey, reservedNodeOfferingId, nodeCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PurchaseReservedNodeOfferingApi#purchaseReservedNodeOffering");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PurchaseReservedNodeOfferingApi;

public class PurchaseReservedNodeOfferingApiExample {

    public static void main(String[] args) {
        PurchaseReservedNodeOfferingApi apiInstance = new PurchaseReservedNodeOfferingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String reservedNodeOfferingId = reservedNodeOfferingId_example; // String | The unique identifier of the reserved node offering you want to purchase.
        String nodeCount = nodeCount_example; // String | The number of reserved nodes that you want to purchase.
        try {
            inline_response_200 result = apiInstance.purchaseReservedNodeOffering(apiecoKey, reservedNodeOfferingId, nodeCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PurchaseReservedNodeOfferingApi#purchaseReservedNodeOffering");
            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 *reservedNodeOfferingId = reservedNodeOfferingId_example; // The unique identifier of the reserved node offering you want to purchase.
String *nodeCount = nodeCount_example; // The number of reserved nodes that you want to purchase.

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

[apiInstance purchaseReservedNodeOfferingWith:apiecoKey
    reservedNodeOfferingId:reservedNodeOfferingId
    nodeCount:nodeCount
              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_.PurchaseReservedNodeOfferingApi()

var apiecoKey = apiecoKey_example; // {String} 

var reservedNodeOfferingId = reservedNodeOfferingId_example; // {String} The unique identifier of the reserved node offering you want to purchase.

var nodeCount = nodeCount_example; // {String} The number of reserved nodes that you want to purchase.


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

namespace Example
{
    public class purchaseReservedNodeOfferingExample
    {
        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 PurchaseReservedNodeOfferingApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var reservedNodeOfferingId = reservedNodeOfferingId_example;  // String | The unique identifier of the reserved node offering you want to purchase.
            var nodeCount = nodeCount_example;  // String | The number of reserved nodes that you want to purchase.

            try
            {
                inline_response_200 result = apiInstance.purchaseReservedNodeOffering(apiecoKey, reservedNodeOfferingId, nodeCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PurchaseReservedNodeOfferingApi.purchaseReservedNodeOffering: " + 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\PurchaseReservedNodeOfferingApi();
$apiecoKey = apiecoKey_example; // String | 
$reservedNodeOfferingId = reservedNodeOfferingId_example; // String | The unique identifier of the reserved node offering you want to purchase.
$nodeCount = nodeCount_example; // String | The number of reserved nodes that you want to purchase.

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

# 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::PurchaseReservedNodeOfferingApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $reservedNodeOfferingId = reservedNodeOfferingId_example; # String | The unique identifier of the reserved node offering you want to purchase.
my $nodeCount = nodeCount_example; # String | The number of reserved nodes that you want to purchase.

eval { 
    my $result = $api_instance->purchaseReservedNodeOffering(apiecoKey => $apiecoKey, reservedNodeOfferingId => $reservedNodeOfferingId, nodeCount => $nodeCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PurchaseReservedNodeOfferingApi->purchaseReservedNodeOffering: $@\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.PurchaseReservedNodeOfferingApi()
apiecoKey = apiecoKey_example # String | 
reservedNodeOfferingId = reservedNodeOfferingId_example # String | The unique identifier of the reserved node offering you want to purchase.
nodeCount = nodeCount_example # String | The number of reserved nodes that you want to purchase.

try: 
    api_response = api_instance.purchase_reserved_node_offering(apiecoKey, reservedNodeOfferingId, nodeCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PurchaseReservedNodeOfferingApi->purchaseReservedNodeOffering: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ReservedNodeOfferingId*
String
The unique identifier of the reserved node offering you want to purchase.
Required
NodeCount*
String
The number of reserved nodes that you want to purchase.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


RebootCluster

rebootCluster

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot.


/RebootCluster

Usage and SDK Samples

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

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

public class RebootClusterApiExample {

    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");

        RebootClusterApi apiInstance = new RebootClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The Cluster Identifier
        try {
            inline_response_200_50 result = apiInstance.rebootCluster(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RebootClusterApi#rebootCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RebootClusterApi;

public class RebootClusterApiExample {

    public static void main(String[] args) {
        RebootClusterApi apiInstance = new RebootClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The Cluster Identifier
        try {
            inline_response_200_50 result = apiInstance.rebootCluster(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RebootClusterApi#rebootCluster");
            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

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

[apiInstance rebootClusterWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_50 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_.RebootClusterApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The Cluster Identifier


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

namespace Example
{
    public class rebootClusterExample
    {
        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 RebootClusterApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The Cluster Identifier

            try
            {
                inline_response_200_50 result = apiInstance.rebootCluster(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RebootClusterApi.rebootCluster: " + 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\RebootClusterApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The Cluster Identifier

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

# 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::RebootClusterApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The Cluster Identifier

eval { 
    my $result = $api_instance->rebootCluster(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RebootClusterApi->rebootCluster: $@\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.RebootClusterApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The Cluster Identifier

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The Cluster Identifier
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ResetClusterParameterGroup

resetClusterParameterGroup

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.


/ResetClusterParameterGroup

Usage and SDK Samples

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

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

public class ResetClusterParameterGroupApiExample {

    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");

        ResetClusterParameterGroupApi apiInstance = new ResetClusterParameterGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of the cluster parameter group to be reset.
        Boolean resetAllParameters = true; // Boolean | If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
        try {
            inline_response_200_52 result = apiInstance.resetClusterParameterGroup(apiecoKey, parameterGroupName, resetAllParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResetClusterParameterGroupApi#resetClusterParameterGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResetClusterParameterGroupApi;

public class ResetClusterParameterGroupApiExample {

    public static void main(String[] args) {
        ResetClusterParameterGroupApi apiInstance = new ResetClusterParameterGroupApi();
        String apiecoKey = apiecoKey_example; // String | 
        String parameterGroupName = parameterGroupName_example; // String | The name of the cluster parameter group to be reset.
        Boolean resetAllParameters = true; // Boolean | If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
        try {
            inline_response_200_52 result = apiInstance.resetClusterParameterGroup(apiecoKey, parameterGroupName, resetAllParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResetClusterParameterGroupApi#resetClusterParameterGroup");
            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 cluster parameter group to be reset.
Boolean *resetAllParameters = true; // If true, all parameters in the specified parameter group will be reset to their default values.
Default: true (optional)

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

[apiInstance resetClusterParameterGroupWith:apiecoKey
    parameterGroupName:parameterGroupName
    resetAllParameters:resetAllParameters
              completionHandler: ^(inline_response_200_52 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_.ResetClusterParameterGroupApi()

var apiecoKey = apiecoKey_example; // {String} 

var parameterGroupName = parameterGroupName_example; // {String} The name of the cluster parameter group to be reset.

var opts = { 
  'resetAllParameters': true // {Boolean} If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
};

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

namespace Example
{
    public class resetClusterParameterGroupExample
    {
        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 ResetClusterParameterGroupApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var parameterGroupName = parameterGroupName_example;  // String | The name of the cluster parameter group to be reset.
            var resetAllParameters = true;  // Boolean | If true, all parameters in the specified parameter group will be reset to their default values.
Default: true (optional) 

            try
            {
                inline_response_200_52 result = apiInstance.resetClusterParameterGroup(apiecoKey, parameterGroupName, resetAllParameters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResetClusterParameterGroupApi.resetClusterParameterGroup: " + 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\ResetClusterParameterGroupApi();
$apiecoKey = apiecoKey_example; // String | 
$parameterGroupName = parameterGroupName_example; // String | The name of the cluster parameter group to be reset.
$resetAllParameters = true; // Boolean | If true, all parameters in the specified parameter group will be reset to their default values.
Default: true

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

# 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::ResetClusterParameterGroupApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $parameterGroupName = parameterGroupName_example; # String | The name of the cluster parameter group to be reset.
my $resetAllParameters = true; # Boolean | If true, all parameters in the specified parameter group will be reset to their default values.
Default: true

eval { 
    my $result = $api_instance->resetClusterParameterGroup(apiecoKey => $apiecoKey, parameterGroupName => $parameterGroupName, resetAllParameters => $resetAllParameters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResetClusterParameterGroupApi->resetClusterParameterGroup: $@\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.ResetClusterParameterGroupApi()
apiecoKey = apiecoKey_example # String | 
parameterGroupName = parameterGroupName_example # String | The name of the cluster parameter group to be reset.
resetAllParameters = true # Boolean | If true, all parameters in the specified parameter group will be reset to their default values.
Default: true (optional)

try: 
    api_response = api_instance.reset_cluster_parameter_group(apiecoKey, parameterGroupName, resetAllParameters=resetAllParameters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResetClusterParameterGroupApi->resetClusterParameterGroup: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ParameterGroupName*
String
The name of the cluster parameter group to be reset.
Required
ResetAllParameters
Boolean
If true, all parameters in the specified parameter group will be reset to their default values. Default: true

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ResizeCluster

resizeCluster

Changes the size of the cluster. You can change the cluster`s type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.


/ResizeCluster

Usage and SDK Samples

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

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

public class ResizeClusterApiExample {

    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");

        ResizeClusterApi apiInstance = new ResizeClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier for the cluster to resize.
        Boolean classic = true; // Boolean | A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic.
        try {
            inline_response_200_50 result = apiInstance.resizeCluster(apiecoKey, clusterIdentifier, classic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResizeClusterApi#resizeCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResizeClusterApi;

public class ResizeClusterApiExample {

    public static void main(String[] args) {
        ResizeClusterApi apiInstance = new ResizeClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier for the cluster to resize.
        Boolean classic = true; // Boolean | A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic.
        try {
            inline_response_200_50 result = apiInstance.resizeCluster(apiecoKey, clusterIdentifier, classic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResizeClusterApi#resizeCluster");
            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 to resize.
Boolean *classic = true; // A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic. (optional)

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

[apiInstance resizeClusterWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    classic:classic
              completionHandler: ^(inline_response_200_50 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_.ResizeClusterApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The unique identifier for the cluster to resize.

var opts = { 
  'classic': true // {Boolean} A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resizeCluster(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 resizeClusterExample
    {
        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 ResizeClusterApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier for the cluster to resize.
            var classic = true;  // Boolean | A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic. (optional) 

            try
            {
                inline_response_200_50 result = apiInstance.resizeCluster(apiecoKey, clusterIdentifier, classic);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResizeClusterApi.resizeCluster: " + 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\ResizeClusterApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier for the cluster to resize.
$classic = true; // Boolean | A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic.

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

# 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::ResizeClusterApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier for the cluster to resize.
my $classic = true; # Boolean | A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic.

eval { 
    my $result = $api_instance->resizeCluster(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, classic => $classic);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResizeClusterApi->resizeCluster: $@\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.ResizeClusterApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The unique identifier for the cluster to resize.
classic = true # Boolean | A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic. (optional)

try: 
    api_response = api_instance.resize_cluster(apiecoKey, clusterIdentifier, classic=classic)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResizeClusterApi->resizeCluster: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The unique identifier for the cluster to resize.
Required
Classic
Boolean
A boolean value indicating whether the resize operation is using the classic resize process. If you don`t provide this parameter or set the value to false, the resize type is elastic.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


RestoreFromClusterSnapshot

restoreFromClusterSnapshot

PDF Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.


/RestoreFromClusterSnapshot

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/RestoreFromClusterSnapshot?ClusterExists=&Marker=&ClusterIdentifier=&EndTime=&MaxRecords=&TagKeys.TagKey.N=&TagValues.TagValue.N="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RestoreFromClusterSnapshotApi;

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

public class RestoreFromClusterSnapshotApiExample {

    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");

        RestoreFromClusterSnapshotApi apiInstance = new RestoreFromClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean clusterExists = true; // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster which generated the requested snapshots.
        String endTime = endTime_example; // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_50 result = apiInstance.restoreFromClusterSnapshot(apiecoKey, clusterExists, marker, clusterIdentifier, endTime, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RestoreFromClusterSnapshotApi#restoreFromClusterSnapshot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RestoreFromClusterSnapshotApi;

public class RestoreFromClusterSnapshotApiExample {

    public static void main(String[] args) {
        RestoreFromClusterSnapshotApi apiInstance = new RestoreFromClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean clusterExists = true; // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
        String marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster which generated the requested snapshots.
        String endTime = endTime_example; // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
        BigDecimal maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
        String tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        String tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        try {
            inline_response_200_50 result = apiInstance.restoreFromClusterSnapshot(apiecoKey, clusterExists, marker, clusterIdentifier, endTime, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RestoreFromClusterSnapshotApi#restoreFromClusterSnapshot");
            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 *clusterExists = true; // A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.          (optional)
String *marker = marker_example; // An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
String *clusterIdentifier = clusterIdentifier_example; // The identifier of the cluster which generated the requested snapshots. (optional)
String *endTime = endTime_example; // A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z (optional)
BigDecimal *maxRecords = 8.14; // The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
String *tagKeys.TagKey.N = tagKeys.TagKey.N_example; // A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
String *tagValues.TagValue.N = tagValues.TagValue.N_example; // A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

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

[apiInstance restoreFromClusterSnapshotWith:apiecoKey
    clusterExists:clusterExists
    marker:marker
    clusterIdentifier:clusterIdentifier
    endTime:endTime
    maxRecords:maxRecords
    tagKeys.TagKey.N:tagKeys.TagKey.N
    tagValues.TagValue.N:tagValues.TagValue.N
              completionHandler: ^(inline_response_200_50 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_.RestoreFromClusterSnapshotApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'clusterExists': true, // {Boolean} A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
  'marker': marker_example, // {String} An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  'clusterIdentifier': clusterIdentifier_example, // {String} The identifier of the cluster which generated the requested snapshots.
  'endTime': endTime_example, // {String} A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
  'maxRecords': 8.14, // {BigDecimal} The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
  'tagKeys.TagKey.N': tagKeys.TagKey.N_example, // {String} A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
  'tagValues.TagValue.N': tagValues.TagValue.N_example // {String} A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
};

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

namespace Example
{
    public class restoreFromClusterSnapshotExample
    {
        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 RestoreFromClusterSnapshotApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterExists = true;  // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.          (optional) 
            var marker = marker_example;  // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional) 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster which generated the requested snapshots. (optional) 
            var endTime = endTime_example;  // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z (optional) 
            var maxRecords = 8.14;  // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional) 
            var tagKeys.TagKey.N = tagKeys.TagKey.N_example;  // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional) 
            var tagValues.TagValue.N = tagValues.TagValue.N_example;  // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional) 

            try
            {
                inline_response_200_50 result = apiInstance.restoreFromClusterSnapshot(apiecoKey, clusterExists, marker, clusterIdentifier, endTime, maxRecords, tagKeys.TagKey.N, tagValues.TagValue.N);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RestoreFromClusterSnapshotApi.restoreFromClusterSnapshot: " + 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\RestoreFromClusterSnapshotApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterExists = true; // Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
$marker = marker_example; // String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster which generated the requested snapshots.
$endTime = endTime_example; // String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
$maxRecords = 8.14; // BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
$tagKeys.TagKey.N = tagKeys.TagKey.N_example; // String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
$tagValues.TagValue.N = tagValues.TagValue.N_example; // String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

try {
    $result = $api_instance->restoreFromClusterSnapshot($apiecoKey, $clusterExists, $marker, $clusterIdentifier, $endTime, $maxRecords, $tagKeys.TagKey.N, $tagValues.TagValue.N);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RestoreFromClusterSnapshotApi->restoreFromClusterSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RestoreFromClusterSnapshotApi;

# 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::RestoreFromClusterSnapshotApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterExists = true; # Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.         
my $marker = marker_example; # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster which generated the requested snapshots.
my $endTime = endTime_example; # String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
my $maxRecords = 8.14; # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
my $tagKeys.TagKey.N = tagKeys.TagKey.N_example; # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
my $tagValues.TagValue.N = tagValues.TagValue.N_example; # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

eval { 
    my $result = $api_instance->restoreFromClusterSnapshot(apiecoKey => $apiecoKey, clusterExists => $clusterExists, marker => $marker, clusterIdentifier => $clusterIdentifier, endTime => $endTime, maxRecords => $maxRecords, tagKeys.TagKey.N => $tagKeys.TagKey.N, tagValues.TagValue.N => $tagValues.TagValue.N);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RestoreFromClusterSnapshotApi->restoreFromClusterSnapshot: $@\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.RestoreFromClusterSnapshotApi()
apiecoKey = apiecoKey_example # String | 
clusterExists = true # Boolean | A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.          (optional)
marker = marker_example # String | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. (optional)
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster which generated the requested snapshots. (optional)
endTime = endTime_example # String | A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z (optional)
maxRecords = 8.14 # BigDecimal | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100. (optional)
tagKeys.TagKey.N = tagKeys.TagKey.N_example # String | A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. (optional)
tagValues.TagValue.N = tagValues.TagValue.N_example # String | A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. (optional)

try: 
    api_response = api_instance.restore_from_cluster_snapshot(apiecoKey, clusterExists=clusterExists, marker=marker, clusterIdentifier=clusterIdentifier, endTime=endTime, maxRecords=maxRecords, tagKeys.TagKey.N=tagKeys.TagKey.N, tagValues.TagValue.N=tagValues.TagValue.N)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RestoreFromClusterSnapshotApi->restoreFromClusterSnapshot: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterExists
Boolean
A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If ClusterExists is set to false and ClusterIdentifier isn`t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned. If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.
Marker
String
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
ClusterIdentifier
String
The identifier of the cluster which generated the requested snapshots.
EndTime
String
A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
MaxRecords
BigDecimal
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys.TagKey.N
String
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues.TagValue.N
String
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


RestoreTableFromClusterSnapshot

restoreTableFromClusterSnapshot

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.


/RestoreTableFromClusterSnapshot

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/AmazonRedshift/RestoreTableFromClusterSnapshot?ClusterIdentifier=&NewTableName=&SnapshotIdentifier=&SourceDatabaseName=&SourceTableName=&SourceSchemaName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RestoreTableFromClusterSnapshotApi;

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

public class RestoreTableFromClusterSnapshotApiExample {

    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");

        RestoreTableFromClusterSnapshotApi apiInstance = new RestoreTableFromClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the Amazon Redshift cluster to restore the table to.
        String newTableName = newTableName_example; // String | The name of the table to create as a result of the current request.
        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
        String sourceTableName = sourceTableName_example; // String | The name of the source table to restore from..
        String sourceDatabaseName = sourceDatabaseName_example; // String | The name of the source database that contains the table to restore from..
        String sourceSchemaName = sourceSchemaName_example; // String | The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
        try {
            inline_response_200_43 result = apiInstance.restoreTableFromClusterSnapshot(apiecoKey, clusterIdentifier, newTableName, snapshotIdentifier, sourceTableName, sourceDatabaseName, sourceSchemaName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RestoreTableFromClusterSnapshotApi#restoreTableFromClusterSnapshot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RestoreTableFromClusterSnapshotApi;

public class RestoreTableFromClusterSnapshotApiExample {

    public static void main(String[] args) {
        RestoreTableFromClusterSnapshotApi apiInstance = new RestoreTableFromClusterSnapshotApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the Amazon Redshift cluster to restore the table to.
        String newTableName = newTableName_example; // String | The name of the table to create as a result of the current request.
        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
        String sourceTableName = sourceTableName_example; // String | The name of the source table to restore from..
        String sourceDatabaseName = sourceDatabaseName_example; // String | The name of the source database that contains the table to restore from..
        String sourceSchemaName = sourceSchemaName_example; // String | The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
        try {
            inline_response_200_43 result = apiInstance.restoreTableFromClusterSnapshot(apiecoKey, clusterIdentifier, newTableName, snapshotIdentifier, sourceTableName, sourceDatabaseName, sourceSchemaName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RestoreTableFromClusterSnapshotApi#restoreTableFromClusterSnapshot");
            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 Amazon Redshift cluster to restore the table to.
String *newTableName = newTableName_example; // The name of the table to create as a result of the current request.
String *snapshotIdentifier = snapshotIdentifier_example; // The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
String *sourceTableName = sourceTableName_example; // The name of the source table to restore from..
String *sourceDatabaseName = sourceDatabaseName_example; // The name of the source database that contains the table to restore from.. (optional)
String *sourceSchemaName = sourceSchemaName_example; // The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public. (optional)

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

[apiInstance restoreTableFromClusterSnapshotWith:apiecoKey
    clusterIdentifier:clusterIdentifier
    newTableName:newTableName
    snapshotIdentifier:snapshotIdentifier
    sourceTableName:sourceTableName
    sourceDatabaseName:sourceDatabaseName
    sourceSchemaName:sourceSchemaName
              completionHandler: ^(inline_response_200_43 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_.RestoreTableFromClusterSnapshotApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The identifier of the Amazon Redshift cluster to restore the table to.

var newTableName = newTableName_example; // {String} The name of the table to create as a result of the current request.

var snapshotIdentifier = snapshotIdentifier_example; // {String} The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

var sourceTableName = sourceTableName_example; // {String} The name of the source table to restore from..

var opts = { 
  'sourceDatabaseName': sourceDatabaseName_example, // {String} The name of the source database that contains the table to restore from..
  'sourceSchemaName': sourceSchemaName_example // {String} The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
};

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

namespace Example
{
    public class restoreTableFromClusterSnapshotExample
    {
        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 RestoreTableFromClusterSnapshotApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the Amazon Redshift cluster to restore the table to.
            var newTableName = newTableName_example;  // String | The name of the table to create as a result of the current request.
            var snapshotIdentifier = snapshotIdentifier_example;  // String | The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
            var sourceTableName = sourceTableName_example;  // String | The name of the source table to restore from..
            var sourceDatabaseName = sourceDatabaseName_example;  // String | The name of the source database that contains the table to restore from.. (optional) 
            var sourceSchemaName = sourceSchemaName_example;  // String | The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public. (optional) 

            try
            {
                inline_response_200_43 result = apiInstance.restoreTableFromClusterSnapshot(apiecoKey, clusterIdentifier, newTableName, snapshotIdentifier, sourceTableName, sourceDatabaseName, sourceSchemaName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RestoreTableFromClusterSnapshotApi.restoreTableFromClusterSnapshot: " + 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\RestoreTableFromClusterSnapshotApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the Amazon Redshift cluster to restore the table to.
$newTableName = newTableName_example; // String | The name of the table to create as a result of the current request.
$snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
$sourceTableName = sourceTableName_example; // String | The name of the source table to restore from..
$sourceDatabaseName = sourceDatabaseName_example; // String | The name of the source database that contains the table to restore from..
$sourceSchemaName = sourceSchemaName_example; // String | The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

try {
    $result = $api_instance->restoreTableFromClusterSnapshot($apiecoKey, $clusterIdentifier, $newTableName, $snapshotIdentifier, $sourceTableName, $sourceDatabaseName, $sourceSchemaName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RestoreTableFromClusterSnapshotApi->restoreTableFromClusterSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RestoreTableFromClusterSnapshotApi;

# 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::RestoreTableFromClusterSnapshotApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the Amazon Redshift cluster to restore the table to.
my $newTableName = newTableName_example; # String | The name of the table to create as a result of the current request.
my $snapshotIdentifier = snapshotIdentifier_example; # String | The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
my $sourceTableName = sourceTableName_example; # String | The name of the source table to restore from..
my $sourceDatabaseName = sourceDatabaseName_example; # String | The name of the source database that contains the table to restore from..
my $sourceSchemaName = sourceSchemaName_example; # String | The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

eval { 
    my $result = $api_instance->restoreTableFromClusterSnapshot(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier, newTableName => $newTableName, snapshotIdentifier => $snapshotIdentifier, sourceTableName => $sourceTableName, sourceDatabaseName => $sourceDatabaseName, sourceSchemaName => $sourceSchemaName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RestoreTableFromClusterSnapshotApi->restoreTableFromClusterSnapshot: $@\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.RestoreTableFromClusterSnapshotApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The identifier of the Amazon Redshift cluster to restore the table to.
newTableName = newTableName_example # String | The name of the table to create as a result of the current request.
snapshotIdentifier = snapshotIdentifier_example # String | The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
sourceTableName = sourceTableName_example # String | The name of the source table to restore from..
sourceDatabaseName = sourceDatabaseName_example # String | The name of the source database that contains the table to restore from.. (optional)
sourceSchemaName = sourceSchemaName_example # String | The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public. (optional)

try: 
    api_response = api_instance.restore_table_from_cluster_snapshot(apiecoKey, clusterIdentifier, newTableName, snapshotIdentifier, sourceTableName, sourceDatabaseName=sourceDatabaseName, sourceSchemaName=sourceSchemaName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RestoreTableFromClusterSnapshotApi->restoreTableFromClusterSnapshot: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The identifier of the Amazon Redshift cluster to restore the table to.
Required
NewTableName*
String
The name of the table to create as a result of the current request.
Required
SnapshotIdentifier*
String
The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
Required
SourceDatabaseName
String
The name of the source database that contains the table to restore from..
SourceTableName*
String
The name of the source table to restore from..
Required
SourceSchemaName
String
The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ResumeCluster

resumeCluster

Resumes a paused cluster.


/ResumeCluster

Usage and SDK Samples

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

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

public class ResumeClusterApiExample {

    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");

        ResumeClusterApi apiInstance = new ResumeClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to be resumed.
        try {
            inline_response_200_50 result = apiInstance.resumeCluster(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResumeClusterApi#resumeCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResumeClusterApi;

public class ResumeClusterApiExample {

    public static void main(String[] args) {
        ResumeClusterApi apiInstance = new ResumeClusterApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to be resumed.
        try {
            inline_response_200_50 result = apiInstance.resumeCluster(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResumeClusterApi#resumeCluster");
            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 resumed.

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

[apiInstance resumeClusterWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_50 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_.ResumeClusterApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The identifier of the cluster to be resumed.


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

namespace Example
{
    public class resumeClusterExample
    {
        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 ResumeClusterApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The identifier of the cluster to be resumed.

            try
            {
                inline_response_200_50 result = apiInstance.resumeCluster(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResumeClusterApi.resumeCluster: " + 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\ResumeClusterApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The identifier of the cluster to be resumed.

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

# 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::ResumeClusterApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The identifier of the cluster to be resumed.

eval { 
    my $result = $api_instance->resumeCluster(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResumeClusterApi->resumeCluster: $@\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.ResumeClusterApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The identifier of the cluster to be resumed.

try: 
    api_response = api_instance.resume_cluster(apiecoKey, clusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResumeClusterApi->resumeCluster: %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 resumed.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


RevokeClusterSecurityGroupIngress

revokeClusterSecurityGroupIngress

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress.


/RevokeClusterSecurityGroupIngress

Usage and SDK Samples

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

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

public class RevokeClusterSecurityGroupIngressApiExample {

    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");

        RevokeClusterSecurityGroupIngressApi apiInstance = new RevokeClusterSecurityGroupIngressApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | TThe name of the security Group from which to revoke the ingress rule.
        String cIDRIP = cIDRIP_example; // String | The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
        String eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // String | The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
        try {
            inline_response_200_53 result = apiInstance.revokeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, cIDRIP, eC2SecurityGroupOwnerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevokeClusterSecurityGroupIngressApi#revokeClusterSecurityGroupIngress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RevokeClusterSecurityGroupIngressApi;

public class RevokeClusterSecurityGroupIngressApiExample {

    public static void main(String[] args) {
        RevokeClusterSecurityGroupIngressApi apiInstance = new RevokeClusterSecurityGroupIngressApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterSecurityGroupName = clusterSecurityGroupName_example; // String | TThe name of the security Group from which to revoke the ingress rule.
        String cIDRIP = cIDRIP_example; // String | The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
        String eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // String | The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
        try {
            inline_response_200_53 result = apiInstance.revokeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, cIDRIP, eC2SecurityGroupOwnerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevokeClusterSecurityGroupIngressApi#revokeClusterSecurityGroupIngress");
            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; // TThe name of the security Group from which to revoke the ingress rule.
String *cIDRIP = cIDRIP_example; // The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided. (optional)
String *eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333 (optional)

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

[apiInstance revokeClusterSecurityGroupIngressWith:apiecoKey
    clusterSecurityGroupName:clusterSecurityGroupName
    cIDRIP:cIDRIP
    eC2SecurityGroupOwnerId:eC2SecurityGroupOwnerId
              completionHandler: ^(inline_response_200_53 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_.RevokeClusterSecurityGroupIngressApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterSecurityGroupName = clusterSecurityGroupName_example; // {String} TThe name of the security Group from which to revoke the ingress rule.

var opts = { 
  'cIDRIP': cIDRIP_example, // {String} The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
  'eC2SecurityGroupOwnerId': eC2SecurityGroupOwnerId_example // {String} The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.revokeClusterSecurityGroupIngress(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 revokeClusterSecurityGroupIngressExample
    {
        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 RevokeClusterSecurityGroupIngressApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterSecurityGroupName = clusterSecurityGroupName_example;  // String | TThe name of the security Group from which to revoke the ingress rule.
            var cIDRIP = cIDRIP_example;  // String | The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided. (optional) 
            var eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example;  // String | The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333 (optional) 

            try
            {
                inline_response_200_53 result = apiInstance.revokeClusterSecurityGroupIngress(apiecoKey, clusterSecurityGroupName, cIDRIP, eC2SecurityGroupOwnerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RevokeClusterSecurityGroupIngressApi.revokeClusterSecurityGroupIngress: " + 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\RevokeClusterSecurityGroupIngressApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterSecurityGroupName = clusterSecurityGroupName_example; // String | TThe name of the security Group from which to revoke the ingress rule.
$cIDRIP = cIDRIP_example; // String | The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
$eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; // String | The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333

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

# 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::RevokeClusterSecurityGroupIngressApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterSecurityGroupName = clusterSecurityGroupName_example; # String | TThe name of the security Group from which to revoke the ingress rule.
my $cIDRIP = cIDRIP_example; # String | The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
my $eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example; # String | The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333

eval { 
    my $result = $api_instance->revokeClusterSecurityGroupIngress(apiecoKey => $apiecoKey, clusterSecurityGroupName => $clusterSecurityGroupName, cIDRIP => $cIDRIP, eC2SecurityGroupOwnerId => $eC2SecurityGroupOwnerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RevokeClusterSecurityGroupIngressApi->revokeClusterSecurityGroupIngress: $@\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.RevokeClusterSecurityGroupIngressApi()
apiecoKey = apiecoKey_example # String | 
clusterSecurityGroupName = clusterSecurityGroupName_example # String | TThe name of the security Group from which to revoke the ingress rule.
cIDRIP = cIDRIP_example # String | The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided. (optional)
eC2SecurityGroupOwnerId = eC2SecurityGroupOwnerId_example # String | The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333 (optional)

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterSecurityGroupName*
String
TThe name of the security Group from which to revoke the ingress rule.
Required
CIDRIP
String
The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
EC2SecurityGroupOwnerId
String
The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. Example: 111122223333

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


RevokeSnapshotAccess

revokeSnapshotAccess

Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.


/RevokeSnapshotAccess

Usage and SDK Samples

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

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

public class RevokeSnapshotAccessApiExample {

    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");

        RevokeSnapshotAccessApi apiInstance = new RevokeSnapshotAccessApi();
        String apiecoKey = apiecoKey_example; // String | 
        String accountWithRestoreAccess = accountWithRestoreAccess_example; // String | The identifier of the AWS customer account that can no longer restore the specified snapshot.
        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot that the account can no longer access.
        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_54 result = apiInstance.revokeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevokeSnapshotAccessApi#revokeSnapshotAccess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RevokeSnapshotAccessApi;

public class RevokeSnapshotAccessApiExample {

    public static void main(String[] args) {
        RevokeSnapshotAccessApi apiInstance = new RevokeSnapshotAccessApi();
        String apiecoKey = apiecoKey_example; // String | 
        String accountWithRestoreAccess = accountWithRestoreAccess_example; // String | The identifier of the AWS customer account that can no longer restore the specified snapshot.
        String snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot that the account can no longer access.
        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_54 result = apiInstance.revokeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RevokeSnapshotAccessApi#revokeSnapshotAccess");
            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 that can no longer restore the specified snapshot.
String *snapshotIdentifier = snapshotIdentifier_example; // The identifier of the snapshot that the account can no longer access.
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)

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

[apiInstance revokeSnapshotAccessWith:apiecoKey
    accountWithRestoreAccess:accountWithRestoreAccess
    snapshotIdentifier:snapshotIdentifier
    snapshotClusterIdentifier:snapshotClusterIdentifier
              completionHandler: ^(inline_response_200_54 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_.RevokeSnapshotAccessApi()

var apiecoKey = apiecoKey_example; // {String} 

var accountWithRestoreAccess = accountWithRestoreAccess_example; // {String} The identifier of the AWS customer account that can no longer restore the specified snapshot.

var snapshotIdentifier = snapshotIdentifier_example; // {String} The identifier of the snapshot that the account can no longer access.

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.revokeSnapshotAccess(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 revokeSnapshotAccessExample
    {
        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 RevokeSnapshotAccessApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var accountWithRestoreAccess = accountWithRestoreAccess_example;  // String | The identifier of the AWS customer account that can no longer restore the specified snapshot.
            var snapshotIdentifier = snapshotIdentifier_example;  // String | The identifier of the snapshot that the account can no longer access.
            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_54 result = apiInstance.revokeSnapshotAccess(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RevokeSnapshotAccessApi.revokeSnapshotAccess: " + 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\RevokeSnapshotAccessApi();
$apiecoKey = apiecoKey_example; // String | 
$accountWithRestoreAccess = accountWithRestoreAccess_example; // String | The identifier of the AWS customer account that can no longer restore the specified snapshot.
$snapshotIdentifier = snapshotIdentifier_example; // String | The identifier of the snapshot that the account can no longer access.
$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->revokeSnapshotAccess($apiecoKey, $accountWithRestoreAccess, $snapshotIdentifier, $snapshotClusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RevokeSnapshotAccessApi->revokeSnapshotAccess: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RevokeSnapshotAccessApi;

# 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::RevokeSnapshotAccessApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $accountWithRestoreAccess = accountWithRestoreAccess_example; # String | The identifier of the AWS customer account that can no longer restore the specified snapshot.
my $snapshotIdentifier = snapshotIdentifier_example; # String | The identifier of the snapshot that the account can no longer access.
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->revokeSnapshotAccess(apiecoKey => $apiecoKey, accountWithRestoreAccess => $accountWithRestoreAccess, snapshotIdentifier => $snapshotIdentifier, snapshotClusterIdentifier => $snapshotClusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RevokeSnapshotAccessApi->revokeSnapshotAccess: $@\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.RevokeSnapshotAccessApi()
apiecoKey = apiecoKey_example # String | 
accountWithRestoreAccess = accountWithRestoreAccess_example # String | The identifier of the AWS customer account that can no longer restore the specified snapshot.
snapshotIdentifier = snapshotIdentifier_example # String | The identifier of the snapshot that the account can no longer access.
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.revoke_snapshot_access(apiecoKey, accountWithRestoreAccess, snapshotIdentifier, snapshotClusterIdentifier=snapshotClusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevokeSnapshotAccessApi->revokeSnapshotAccess: %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 that can no longer restore the specified snapshot.
Required
SnapshotIdentifier*
String
The identifier of the snapshot that the account can no longer access.
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


RotateEncryptionKey

rotateEncryptionKey

Rotates the encryption keys for a cluster.


/RotateEncryptionKey

Usage and SDK Samples

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

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

public class RotateEncryptionKeyApiExample {

    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");

        RotateEncryptionKeyApi apiInstance = new RotateEncryptionKeyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
        try {
            inline_response_200_50 result = apiInstance.rotateEncryptionKey(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RotateEncryptionKeyApi#rotateEncryptionKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RotateEncryptionKeyApi;

public class RotateEncryptionKeyApiExample {

    public static void main(String[] args) {
        RotateEncryptionKeyApi apiInstance = new RotateEncryptionKeyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
        try {
            inline_response_200_50 result = apiInstance.rotateEncryptionKey(apiecoKey, clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RotateEncryptionKeyApi#rotateEncryptionKey");
            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 of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.

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

[apiInstance rotateEncryptionKeyWith:apiecoKey
    clusterIdentifier:clusterIdentifier
              completionHandler: ^(inline_response_200_50 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_.RotateEncryptionKeyApi()

var apiecoKey = apiecoKey_example; // {String} 

var clusterIdentifier = clusterIdentifier_example; // {String} The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.


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

namespace Example
{
    public class rotateEncryptionKeyExample
    {
        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 RotateEncryptionKeyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var clusterIdentifier = clusterIdentifier_example;  // String | The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.

            try
            {
                inline_response_200_50 result = apiInstance.rotateEncryptionKey(apiecoKey, clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RotateEncryptionKeyApi.rotateEncryptionKey: " + 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\RotateEncryptionKeyApi();
$apiecoKey = apiecoKey_example; // String | 
$clusterIdentifier = clusterIdentifier_example; // String | The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.

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

# 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::RotateEncryptionKeyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $clusterIdentifier = clusterIdentifier_example; # String | The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.

eval { 
    my $result = $api_instance->rotateEncryptionKey(apiecoKey => $apiecoKey, clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RotateEncryptionKeyApi->rotateEncryptionKey: $@\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.RotateEncryptionKeyApi()
apiecoKey = apiecoKey_example # String | 
clusterIdentifier = clusterIdentifier_example # String | The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.

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

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
ClusterIdentifier*
String
The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled.
Required

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input