AddSourceIdentifierToSubscription

$result = $client->addSourceIdentifierToSubscription([/* ... */]);
$promise = $client->addSourceIdentifierToSubscriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->addSourceIdentifierToSubscription([
    'SourceIdentifier' => '<string>', // REQUIRED
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

SubscriptionNotFoundFault:

The subscription name does not exist.

SourceNotFoundFault:

The requested source could not be found.

AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceName' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

AuthorizeDBSecurityGroupIngress

$result = $client->authorizeDBSecurityGroupIngress([/* ... */]);
$promise = $client->authorizeDBSecurityGroupIngressAsync([/* ... */]);

Parameter Syntax

$result = $client->authorizeDBSecurityGroupIngress([
    'CIDRIP' => '<string>',
    'DBSecurityGroupName' => '<string>', // REQUIRED
    'EC2SecurityGroupId' => '<string>',
    'EC2SecurityGroupName' => '<string>',
    'EC2SecurityGroupOwnerId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DBSecurityGroup' => [
        'DBSecurityGroupDescription' => '<string>',
        'DBSecurityGroupName' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupId' => '<string>',
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'IPRanges' => [
            [
                'CIDRIP' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'OwnerId' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

InvalidDBSecurityGroupStateFault:

The state of the DB security group doesn't allow deletion.

AuthorizationAlreadyExistsFault:

The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

AuthorizationQuotaExceededFault:

The DB security group authorization quota has been reached.

CopyDBParameterGroup

$result = $client->copyDBParameterGroup([/* ... */]);
$promise = $client->copyDBParameterGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->copyDBParameterGroup([
    'SourceDBParameterGroupIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDBParameterGroupDescription' => '<string>', // REQUIRED
    'TargetDBParameterGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DBParameterGroup' => [
        'DBParameterGroupFamily' => '<string>',
        'DBParameterGroupName' => '<string>',
        'Description' => '<string>',
    ],
]

Result Details

Errors

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DBParameterGroupAlreadyExistsFault:

A DB parameter group with the same name exists.

DBParameterGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB parameter groups.

CopyDBSnapshot

$result = $client->copyDBSnapshot([/* ... */]);
$promise = $client->copyDBSnapshotAsync([/* ... */]);

Parameter Syntax

$result = $client->copyDBSnapshot([
    'DestinationRegion' => '<string>',
    'SourceDBSnapshotIdentifier' => '<string>', // REQUIRED
    'SourceRegion' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDBSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DBSnapshot' => [
        'AllocatedStorage' => <integer>,
        'AvailabilityZone' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBSnapshotIdentifier' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'OptionGroupName' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSnapshotAlreadyExistsFault:

DBSnapshotIdentifier is already used by an existing snapshot.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

InvalidDBSnapshotStateFault:

The state of the DB snapshot doesn't allow deletion.

SnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB snapshots.

CopyOptionGroup

$result = $client->copyOptionGroup([/* ... */]);
$promise = $client->copyOptionGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->copyOptionGroup([
    'SourceOptionGroupIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetOptionGroupDescription' => '<string>', // REQUIRED
    'TargetOptionGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'OptionGroup' => [
        'AllowsVpcAndNonVpcInstanceMemberships' => true || false,
        'EngineName' => '<string>',
        'MajorEngineVersion' => '<string>',
        'OptionGroupDescription' => '<string>',
        'OptionGroupName' => '<string>',
        'Options' => [
            [
                'DBSecurityGroupMemberships' => [
                    [
                        'DBSecurityGroupName' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'OptionDescription' => '<string>',
                'OptionName' => '<string>',
                'OptionSettings' => [
                    [
                        'AllowedValues' => '<string>',
                        'ApplyType' => '<string>',
                        'DataType' => '<string>',
                        'DefaultValue' => '<string>',
                        'Description' => '<string>',
                        'IsCollection' => true || false,
                        'IsModifiable' => true || false,
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Permanent' => true || false,
                'Persistent' => true || false,
                'Port' => <integer>,
                'VpcSecurityGroupMemberships' => [
                    [
                        'Status' => '<string>',
                        'VpcSecurityGroupId' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

OptionGroupAlreadyExistsFault:

The option group you are trying to create already exists.

OptionGroupNotFoundFault:

The specified option group could not be found.

OptionGroupQuotaExceededFault:

The quota of 20 option groups was exceeded for this Amazon Web Services account.

CreateDBInstance

$result = $client->createDBInstance([/* ... */]);
$promise = $client->createDBInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->createDBInstance([
    'AllocatedStorage' => <integer>, // REQUIRED
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'BackupRetentionPeriod' => <integer>,
    'CharacterSetName' => '<string>',
    'DBInstanceClass' => '<string>', // REQUIRED
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBName' => '<string>',
    'DBParameterGroupName' => '<string>',
    'DBSecurityGroups' => ['<string>', ...],
    'DBSubnetGroupName' => '<string>',
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>',
    'Iops' => <integer>,
    'LicenseModel' => '<string>',
    'MasterUserPassword' => '<string>', // REQUIRED
    'MasterUsername' => '<string>', // REQUIRED
    'MultiAZ' => true || false,
    'OptionGroupName' => '<string>',
    'Port' => <integer>,
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'PubliclyAccessible' => true || false,
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TdeCredentialArn' => '<string>',
    'TdeCredentialPassword' => '<string>',
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceAlreadyExistsFault:

The user already has a DB instance with the given identifier.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

InstanceQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB instances.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

ProvisionedIopsNotAvailableInAZFault:

Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundFault:

The specified option group could not be found.

StorageTypeNotSupportedFault:

The specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundFault:

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

CreateDBInstanceReadReplica

$result = $client->createDBInstanceReadReplica([/* ... */]);
$promise = $client->createDBInstanceReadReplicaAsync([/* ... */]);

Parameter Syntax

$result = $client->createDBInstanceReadReplica([
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'DBInstanceClass' => '<string>',
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBSubnetGroupName' => '<string>',
    'DestinationRegion' => '<string>',
    'Iops' => <integer>,
    'OptionGroupName' => '<string>',
    'Port' => <integer>,
    'PubliclyAccessible' => true || false,
    'SourceDBInstanceIdentifier' => '<string>', // REQUIRED
    'SourceRegion' => '<string>',
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceAlreadyExistsFault:

The user already has a DB instance with the given identifier.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

InstanceQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB instances.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

ProvisionedIopsNotAvailableInAZFault:

Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundFault:

The specified option group could not be found.

DBSubnetGroupNotAllowedFault:

The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.

InvalidDBSubnetGroupFault:

The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

StorageTypeNotSupportedFault:

The specified StorageType can't be associated with the DB instance.

CreateDBParameterGroup

$result = $client->createDBParameterGroup([/* ... */]);
$promise = $client->createDBParameterGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createDBParameterGroup([
    'DBParameterGroupFamily' => '<string>', // REQUIRED
    'DBParameterGroupName' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DBParameterGroup' => [
        'DBParameterGroupFamily' => '<string>',
        'DBParameterGroupName' => '<string>',
        'Description' => '<string>',
    ],
]

Result Details

Errors

DBParameterGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB parameter groups.

DBParameterGroupAlreadyExistsFault:

A DB parameter group with the same name exists.

CreateDBSecurityGroup

$result = $client->createDBSecurityGroup([/* ... */]);
$promise = $client->createDBSecurityGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createDBSecurityGroup([
    'DBSecurityGroupDescription' => '<string>', // REQUIRED
    'DBSecurityGroupName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DBSecurityGroup' => [
        'DBSecurityGroupDescription' => '<string>',
        'DBSecurityGroupName' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupId' => '<string>',
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'IPRanges' => [
            [
                'CIDRIP' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'OwnerId' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSecurityGroupAlreadyExistsFault:

A DB security group with the name specified in DBSecurityGroupName already exists.

DBSecurityGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB security groups.

DBSecurityGroupNotSupportedFault:

A DB security group isn't allowed for this action.

CreateDBSnapshot

$result = $client->createDBSnapshot([/* ... */]);
$promise = $client->createDBSnapshotAsync([/* ... */]);

Parameter Syntax

$result = $client->createDBSnapshot([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBSnapshotIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DBSnapshot' => [
        'AllocatedStorage' => <integer>,
        'AvailabilityZone' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBSnapshotIdentifier' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'OptionGroupName' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSnapshotAlreadyExistsFault:

DBSnapshotIdentifier is already used by an existing snapshot.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

SnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB snapshots.

CreateDBSubnetGroup

$result = $client->createDBSubnetGroup([/* ... */]);
$promise = $client->createDBSubnetGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createDBSubnetGroup([
    'DBSubnetGroupDescription' => '<string>', // REQUIRED
    'DBSubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DBSubnetGroup' => [
        'DBSubnetGroupDescription' => '<string>',
        'DBSubnetGroupName' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSubnetGroupAlreadyExistsFault:

DBSubnetGroupName is already used by an existing DB subnet group.

DBSubnetGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB subnet groups.

DBSubnetQuotaExceededFault:

The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

CreateEventSubscription

$result = $client->createEventSubscription([/* ... */]);
$promise = $client->createEventSubscriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->createEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'SnsTopicArn' => '<string>', // REQUIRED
    'SourceIds' => ['<string>', ...],
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

EventSubscriptionQuotaExceededFault:

You have reached the maximum number of event subscriptions.

SubscriptionAlreadyExistFault:

The supplied subscription name already exists.

SNSInvalidTopicFault:

SNS has responded that there is a problem with the SNS topic specified.

SNSNoAuthorizationFault:

You do not have permission to publish to the SNS topic ARN.

SNSTopicArnNotFoundFault:

The SNS topic ARN does not exist.

SubscriptionCategoryNotFoundFault:

The supplied category does not exist.

SourceNotFoundFault:

The requested source could not be found.

CreateOptionGroup

$result = $client->createOptionGroup([/* ... */]);
$promise = $client->createOptionGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createOptionGroup([
    'EngineName' => '<string>', // REQUIRED
    'MajorEngineVersion' => '<string>', // REQUIRED
    'OptionGroupDescription' => '<string>', // REQUIRED
    'OptionGroupName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'OptionGroup' => [
        'AllowsVpcAndNonVpcInstanceMemberships' => true || false,
        'EngineName' => '<string>',
        'MajorEngineVersion' => '<string>',
        'OptionGroupDescription' => '<string>',
        'OptionGroupName' => '<string>',
        'Options' => [
            [
                'DBSecurityGroupMemberships' => [
                    [
                        'DBSecurityGroupName' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'OptionDescription' => '<string>',
                'OptionName' => '<string>',
                'OptionSettings' => [
                    [
                        'AllowedValues' => '<string>',
                        'ApplyType' => '<string>',
                        'DataType' => '<string>',
                        'DefaultValue' => '<string>',
                        'Description' => '<string>',
                        'IsCollection' => true || false,
                        'IsModifiable' => true || false,
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Permanent' => true || false,
                'Persistent' => true || false,
                'Port' => <integer>,
                'VpcSecurityGroupMemberships' => [
                    [
                        'Status' => '<string>',
                        'VpcSecurityGroupId' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

OptionGroupAlreadyExistsFault:

The option group you are trying to create already exists.

OptionGroupQuotaExceededFault:

The quota of 20 option groups was exceeded for this Amazon Web Services account.

DeleteDBInstance

$result = $client->deleteDBInstance([/* ... */]);
$promise = $client->deleteDBInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDBInstance([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'FinalDBSnapshotIdentifier' => '<string>',
    'SkipFinalSnapshot' => true || false,
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBSnapshotAlreadyExistsFault:

DBSnapshotIdentifier is already used by an existing snapshot.

SnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB snapshots.

DeleteDBParameterGroup

$result = $client->deleteDBParameterGroup([/* ... */]);
$promise = $client->deleteDBParameterGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDBParameterGroup([
    'DBParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidDBParameterGroupStateFault:

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DeleteDBSecurityGroup

$result = $client->deleteDBSecurityGroup([/* ... */]);
$promise = $client->deleteDBSecurityGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDBSecurityGroup([
    'DBSecurityGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidDBSecurityGroupStateFault:

The state of the DB security group doesn't allow deletion.

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

DeleteDBSnapshot

$result = $client->deleteDBSnapshot([/* ... */]);
$promise = $client->deleteDBSnapshotAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDBSnapshot([
    'DBSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DBSnapshot' => [
        'AllocatedStorage' => <integer>,
        'AvailabilityZone' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBSnapshotIdentifier' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'OptionGroupName' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

InvalidDBSnapshotStateFault:

The state of the DB snapshot doesn't allow deletion.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

DeleteDBSubnetGroup

$result = $client->deleteDBSubnetGroup([/* ... */]);
$promise = $client->deleteDBSubnetGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDBSubnetGroup([
    'DBSubnetGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidDBSubnetGroupStateFault:

The DB subnet group cannot be deleted because it's in use.

InvalidDBSubnetStateFault:

The DB subnet isn't in the available state.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DeleteEventSubscription

$result = $client->deleteEventSubscription([/* ... */]);
$promise = $client->deleteEventSubscriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteEventSubscription([
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

SubscriptionNotFoundFault:

The subscription name does not exist.

InvalidEventSubscriptionStateFault:

This error can occur if someone else is modifying a subscription. You should retry the action.

DeleteOptionGroup

$result = $client->deleteOptionGroup([/* ... */]);
$promise = $client->deleteOptionGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteOptionGroup([
    'OptionGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OptionGroupNotFoundFault:

The specified option group could not be found.

InvalidOptionGroupStateFault:

The option group isn't in the available state.

DescribeDBEngineVersions

$result = $client->describeDBEngineVersions([/* ... */]);
$promise = $client->describeDBEngineVersionsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBEngineVersions([
    'DBParameterGroupFamily' => '<string>',
    'DefaultOnly' => true || false,
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'ListSupportedCharacterSets' => true || false,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DBEngineVersions' => [
        [
            'DBEngineDescription' => '<string>',
            'DBEngineVersionDescription' => '<string>',
            'DBParameterGroupFamily' => '<string>',
            'DefaultCharacterSet' => [
                'CharacterSetDescription' => '<string>',
                'CharacterSetName' => '<string>',
            ],
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'SupportedCharacterSets' => [
                [
                    'CharacterSetDescription' => '<string>',
                    'CharacterSetName' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeDBInstances

$result = $client->describeDBInstances([/* ... */]);
$promise = $client->describeDBInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBInstances([
    'DBInstanceIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DBInstances' => [
        [
            'AllocatedStorage' => <integer>,
            'AutoMinorVersionUpgrade' => true || false,
            'AvailabilityZone' => '<string>',
            'BackupRetentionPeriod' => <integer>,
            'CharacterSetName' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBInstanceStatus' => '<string>',
            'DBName' => '<string>',
            'DBParameterGroups' => [
                [
                    'DBParameterGroupName' => '<string>',
                    'ParameterApplyStatus' => '<string>',
                ],
                // ...
            ],
            'DBSecurityGroups' => [
                [
                    'DBSecurityGroupName' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'DBSubnetGroup' => [
                'DBSubnetGroupDescription' => '<string>',
                'DBSubnetGroupName' => '<string>',
                'SubnetGroupStatus' => '<string>',
                'Subnets' => [
                    [
                        'SubnetAvailabilityZone' => [
                            'Name' => '<string>',
                        ],
                        'SubnetIdentifier' => '<string>',
                        'SubnetStatus' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
            ],
            'Endpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
            ],
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'InstanceCreateTime' => <DateTime>,
            'Iops' => <integer>,
            'LatestRestorableTime' => <DateTime>,
            'LicenseModel' => '<string>',
            'MasterUsername' => '<string>',
            'MultiAZ' => true || false,
            'OptionGroupMemberships' => [
                [
                    'OptionGroupName' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'PendingModifiedValues' => [
                'AllocatedStorage' => <integer>,
                'BackupRetentionPeriod' => <integer>,
                'DBInstanceClass' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'EngineVersion' => '<string>',
                'Iops' => <integer>,
                'MasterUserPassword' => '<string>',
                'MultiAZ' => true || false,
                'Port' => <integer>,
                'StorageType' => '<string>',
            ],
            'PreferredBackupWindow' => '<string>',
            'PreferredMaintenanceWindow' => '<string>',
            'PubliclyAccessible' => true || false,
            'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
            'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
            'SecondaryAvailabilityZone' => '<string>',
            'StatusInfos' => [
                [
                    'Message' => '<string>',
                    'Normal' => true || false,
                    'Status' => '<string>',
                    'StatusType' => '<string>',
                ],
                // ...
            ],
            'StorageType' => '<string>',
            'TdeCredentialArn' => '<string>',
            'VpcSecurityGroups' => [
                [
                    'Status' => '<string>',
                    'VpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DescribeDBLogFiles

$result = $client->describeDBLogFiles([/* ... */]);
$promise = $client->describeDBLogFilesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBLogFiles([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'FileLastWritten' => <integer>,
    'FileSize' => <integer>,
    'FilenameContains' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DescribeDBLogFiles' => [
        [
            'LastWritten' => <integer>,
            'LogFileName' => '<string>',
            'Size' => <integer>,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DescribeDBParameterGroups

$result = $client->describeDBParameterGroups([/* ... */]);
$promise = $client->describeDBParameterGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBParameterGroups([
    'DBParameterGroupName' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DBParameterGroups' => [
        [
            'DBParameterGroupFamily' => '<string>',
            'DBParameterGroupName' => '<string>',
            'Description' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DescribeDBParameters

$result = $client->describeDBParameters([/* ... */]);
$promise = $client->describeDBParametersAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBParameters([
    'DBParameterGroupName' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'Source' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ApplyMethod' => 'immediate|pending-reboot',
            'ApplyType' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DescribeDBSecurityGroups

$result = $client->describeDBSecurityGroups([/* ... */]);
$promise = $client->describeDBSecurityGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBSecurityGroups([
    'DBSecurityGroupName' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DBSecurityGroups' => [
        [
            'DBSecurityGroupDescription' => '<string>',
            'DBSecurityGroupName' => '<string>',
            'EC2SecurityGroups' => [
                [
                    'EC2SecurityGroupId' => '<string>',
                    'EC2SecurityGroupName' => '<string>',
                    'EC2SecurityGroupOwnerId' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'IPRanges' => [
                [
                    'CIDRIP' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'OwnerId' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

DescribeDBSnapshots

$result = $client->describeDBSnapshots([/* ... */]);
$promise = $client->describeDBSnapshotsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBSnapshots([
    'DBInstanceIdentifier' => '<string>',
    'DBSnapshotIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SnapshotType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DBSnapshots' => [
        [
            'AllocatedStorage' => <integer>,
            'AvailabilityZone' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBSnapshotIdentifier' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'InstanceCreateTime' => <DateTime>,
            'Iops' => <integer>,
            'LicenseModel' => '<string>',
            'MasterUsername' => '<string>',
            'OptionGroupName' => '<string>',
            'PercentProgress' => <integer>,
            'Port' => <integer>,
            'SnapshotCreateTime' => <DateTime>,
            'SnapshotType' => '<string>',
            'SourceRegion' => '<string>',
            'Status' => '<string>',
            'StorageType' => '<string>',
            'TdeCredentialArn' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

DescribeDBSubnetGroups

$result = $client->describeDBSubnetGroups([/* ... */]);
$promise = $client->describeDBSubnetGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDBSubnetGroups([
    'DBSubnetGroupName' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DBSubnetGroups' => [
        [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DescribeEngineDefaultParameters

$result = $client->describeEngineDefaultParameters([/* ... */]);
$promise = $client->describeEngineDefaultParametersAsync([/* ... */]);

Parameter Syntax

$result = $client->describeEngineDefaultParameters([
    'DBParameterGroupFamily' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'EngineDefaults' => [
        'DBParameterGroupFamily' => '<string>',
        'Marker' => '<string>',
        'Parameters' => [
            [
                'AllowedValues' => '<string>',
                'ApplyMethod' => 'immediate|pending-reboot',
                'ApplyType' => '<string>',
                'DataType' => '<string>',
                'Description' => '<string>',
                'IsModifiable' => true || false,
                'MinimumEngineVersion' => '<string>',
                'ParameterName' => '<string>',
                'ParameterValue' => '<string>',
                'Source' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeEventCategories

$result = $client->describeEventCategories([/* ... */]);
$promise = $client->describeEventCategoriesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeEventCategories([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'SourceType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventCategoriesMapList' => [
        [
            'EventCategories' => ['<string>', ...],
            'SourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeEventSubscriptions

$result = $client->describeEventSubscriptions([/* ... */]);
$promise = $client->describeEventSubscriptionsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeEventSubscriptions([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SubscriptionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventSubscriptionsList' => [
        [
            'CustSubscriptionId' => '<string>',
            'CustomerAwsId' => '<string>',
            'Enabled' => true || false,
            'EventCategoriesList' => ['<string>', ...],
            'SnsTopicArn' => '<string>',
            'SourceIdsList' => ['<string>', ...],
            'SourceType' => '<string>',
            'Status' => '<string>',
            'SubscriptionCreationTime' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

SubscriptionNotFoundFault:

The subscription name does not exist.

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'EventCategories' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SourceIdentifier' => '<string>',
    'SourceType' => 'db-instance|db-parameter-group|db-security-group|db-snapshot',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'EventCategories' => ['<string>', ...],
            'Message' => '<string>',
            'SourceIdentifier' => '<string>',
            'SourceType' => 'db-instance|db-parameter-group|db-security-group|db-snapshot',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeOptionGroupOptions

$result = $client->describeOptionGroupOptions([/* ... */]);
$promise = $client->describeOptionGroupOptionsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeOptionGroupOptions([
    'EngineName' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MajorEngineVersion' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'OptionGroupOptions' => [
        [
            'DefaultPort' => <integer>,
            'Description' => '<string>',
            'EngineName' => '<string>',
            'MajorEngineVersion' => '<string>',
            'MinimumRequiredMinorEngineVersion' => '<string>',
            'Name' => '<string>',
            'OptionGroupOptionSettings' => [
                [
                    'AllowedValues' => '<string>',
                    'ApplyType' => '<string>',
                    'DefaultValue' => '<string>',
                    'IsModifiable' => true || false,
                    'SettingDescription' => '<string>',
                    'SettingName' => '<string>',
                ],
                // ...
            ],
            'OptionsDependedOn' => ['<string>', ...],
            'Permanent' => true || false,
            'Persistent' => true || false,
            'PortRequired' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeOptionGroups

$result = $client->describeOptionGroups([/* ... */]);
$promise = $client->describeOptionGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeOptionGroups([
    'EngineName' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MajorEngineVersion' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'OptionGroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'OptionGroupsList' => [
        [
            'AllowsVpcAndNonVpcInstanceMemberships' => true || false,
            'EngineName' => '<string>',
            'MajorEngineVersion' => '<string>',
            'OptionGroupDescription' => '<string>',
            'OptionGroupName' => '<string>',
            'Options' => [
                [
                    'DBSecurityGroupMemberships' => [
                        [
                            'DBSecurityGroupName' => '<string>',
                            'Status' => '<string>',
                        ],
                        // ...
                    ],
                    'OptionDescription' => '<string>',
                    'OptionName' => '<string>',
                    'OptionSettings' => [
                        [
                            'AllowedValues' => '<string>',
                            'ApplyType' => '<string>',
                            'DataType' => '<string>',
                            'DefaultValue' => '<string>',
                            'Description' => '<string>',
                            'IsCollection' => true || false,
                            'IsModifiable' => true || false,
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'Permanent' => true || false,
                    'Persistent' => true || false,
                    'Port' => <integer>,
                    'VpcSecurityGroupMemberships' => [
                        [
                            'Status' => '<string>',
                            'VpcSecurityGroupId' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

OptionGroupNotFoundFault:

The specified option group could not be found.

DescribeOrderableDBInstanceOptions

$result = $client->describeOrderableDBInstanceOptions([/* ... */]);
$promise = $client->describeOrderableDBInstanceOptionsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeOrderableDBInstanceOptions([
    'DBInstanceClass' => '<string>',
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'LicenseModel' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'Vpc' => true || false,
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'OrderableDBInstanceOptions' => [
        [
            'AvailabilityZones' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'DBInstanceClass' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'LicenseModel' => '<string>',
            'MultiAZCapable' => true || false,
            'ReadReplicaCapable' => true || false,
            'StorageType' => '<string>',
            'SupportsIops' => true || false,
            'Vpc' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeReservedDBInstances

$result = $client->describeReservedDBInstances([/* ... */]);
$promise = $client->describeReservedDBInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeReservedDBInstances([
    'DBInstanceClass' => '<string>',
    'Duration' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'MultiAZ' => true || false,
    'OfferingType' => '<string>',
    'ProductDescription' => '<string>',
    'ReservedDBInstanceId' => '<string>',
    'ReservedDBInstancesOfferingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'ReservedDBInstances' => [
        [
            'CurrencyCode' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceCount' => <integer>,
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'MultiAZ' => true || false,
            'OfferingType' => '<string>',
            'ProductDescription' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedDBInstanceId' => '<string>',
            'ReservedDBInstancesOfferingId' => '<string>',
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ReservedDBInstanceNotFoundFault:

The specified reserved DB Instance not found.

DescribeReservedDBInstancesOfferings

$result = $client->describeReservedDBInstancesOfferings([/* ... */]);
$promise = $client->describeReservedDBInstancesOfferingsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeReservedDBInstancesOfferings([
    'DBInstanceClass' => '<string>',
    'Duration' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'MultiAZ' => true || false,
    'OfferingType' => '<string>',
    'ProductDescription' => '<string>',
    'ReservedDBInstancesOfferingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'ReservedDBInstancesOfferings' => [
        [
            'CurrencyCode' => '<string>',
            'DBInstanceClass' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'MultiAZ' => true || false,
            'OfferingType' => '<string>',
            'ProductDescription' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedDBInstancesOfferingId' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

ReservedDBInstancesOfferingNotFoundFault:

Specified offering does not exist.

DownloadDBLogFilePortion

$result = $client->downloadDBLogFilePortion([/* ... */]);
$promise = $client->downloadDBLogFilePortionAsync([/* ... */]);

Parameter Syntax

$result = $client->downloadDBLogFilePortion([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'LogFileName' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'NumberOfLines' => <integer>,
]);

Parameter Details

Result Syntax

[
    'AdditionalDataPending' => true || false,
    'LogFileData' => '<string>',
    'Marker' => '<string>',
]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBLogFileNotFoundFault:

LogFileName doesn't refer to an existing DB log file.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->listTagsForResource([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'ResourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

ModifyDBInstance

$result = $client->modifyDBInstance([/* ... */]);
$promise = $client->modifyDBInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyDBInstance([
    'AllocatedStorage' => <integer>,
    'AllowMajorVersionUpgrade' => true || false,
    'ApplyImmediately' => true || false,
    'AutoMinorVersionUpgrade' => true || false,
    'BackupRetentionPeriod' => <integer>,
    'DBInstanceClass' => '<string>',
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBParameterGroupName' => '<string>',
    'DBSecurityGroups' => ['<string>', ...],
    'EngineVersion' => '<string>',
    'Iops' => <integer>,
    'MasterUserPassword' => '<string>',
    'MultiAZ' => true || false,
    'NewDBInstanceIdentifier' => '<string>',
    'OptionGroupName' => '<string>',
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'StorageType' => '<string>',
    'TdeCredentialArn' => '<string>',
    'TdeCredentialPassword' => '<string>',
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

InvalidDBSecurityGroupStateFault:

The state of the DB security group doesn't allow deletion.

DBInstanceAlreadyExistsFault:

The user already has a DB instance with the given identifier.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

ProvisionedIopsNotAvailableInAZFault:

Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundFault:

The specified option group could not be found.

DBUpgradeDependencyFailureFault:

The DB upgrade failed because a resource the DB depends on can't be modified.

StorageTypeNotSupportedFault:

The specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundFault:

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

ModifyDBParameterGroup

$result = $client->modifyDBParameterGroup([/* ... */]);
$promise = $client->modifyDBParameterGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyDBParameterGroup([
    'DBParameterGroupName' => '<string>', // REQUIRED
    'Parameters' => [ // REQUIRED
        [
            'AllowedValues' => '<string>',
            'ApplyMethod' => 'immediate|pending-reboot',
            'ApplyType' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DBParameterGroupName' => '<string>',
]

Result Details

Errors

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

InvalidDBParameterGroupStateFault:

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

ModifyDBSubnetGroup

$result = $client->modifyDBSubnetGroup([/* ... */]);
$promise = $client->modifyDBSubnetGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyDBSubnetGroup([
    'DBSubnetGroupDescription' => '<string>',
    'DBSubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DBSubnetGroup' => [
        'DBSubnetGroupDescription' => '<string>',
        'DBSubnetGroupName' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DBSubnetQuotaExceededFault:

The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

SubnetAlreadyInUse:

The DB subnet is already in use in the Availability Zone.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

ModifyEventSubscription

$result = $client->modifyEventSubscription([/* ... */]);
$promise = $client->modifyEventSubscriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'SnsTopicArn' => '<string>',
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

EventSubscriptionQuotaExceededFault:

You have reached the maximum number of event subscriptions.

SubscriptionNotFoundFault:

The subscription name does not exist.

SNSInvalidTopicFault:

SNS has responded that there is a problem with the SNS topic specified.

SNSNoAuthorizationFault:

You do not have permission to publish to the SNS topic ARN.

SNSTopicArnNotFoundFault:

The SNS topic ARN does not exist.

SubscriptionCategoryNotFoundFault:

The supplied category does not exist.

ModifyOptionGroup

$result = $client->modifyOptionGroup([/* ... */]);
$promise = $client->modifyOptionGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->modifyOptionGroup([
    'ApplyImmediately' => true || false,
    'OptionGroupName' => '<string>', // REQUIRED
    'OptionsToInclude' => [
        [
            'DBSecurityGroupMemberships' => ['<string>', ...],
            'OptionName' => '<string>', // REQUIRED
            'OptionSettings' => [
                [
                    'AllowedValues' => '<string>',
                    'ApplyType' => '<string>',
                    'DataType' => '<string>',
                    'DefaultValue' => '<string>',
                    'Description' => '<string>',
                    'IsCollection' => true || false,
                    'IsModifiable' => true || false,
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Port' => <integer>,
            'VpcSecurityGroupMemberships' => ['<string>', ...],
        ],
        // ...
    ],
    'OptionsToRemove' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'OptionGroup' => [
        'AllowsVpcAndNonVpcInstanceMemberships' => true || false,
        'EngineName' => '<string>',
        'MajorEngineVersion' => '<string>',
        'OptionGroupDescription' => '<string>',
        'OptionGroupName' => '<string>',
        'Options' => [
            [
                'DBSecurityGroupMemberships' => [
                    [
                        'DBSecurityGroupName' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'OptionDescription' => '<string>',
                'OptionName' => '<string>',
                'OptionSettings' => [
                    [
                        'AllowedValues' => '<string>',
                        'ApplyType' => '<string>',
                        'DataType' => '<string>',
                        'DefaultValue' => '<string>',
                        'Description' => '<string>',
                        'IsCollection' => true || false,
                        'IsModifiable' => true || false,
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Permanent' => true || false,
                'Persistent' => true || false,
                'Port' => <integer>,
                'VpcSecurityGroupMemberships' => [
                    [
                        'Status' => '<string>',
                        'VpcSecurityGroupId' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

InvalidOptionGroupStateFault:

The option group isn't in the available state.

OptionGroupNotFoundFault:

The specified option group could not be found.

PromoteReadReplica

$result = $client->promoteReadReplica([/* ... */]);
$promise = $client->promoteReadReplicaAsync([/* ... */]);

Parameter Syntax

$result = $client->promoteReadReplica([
    'BackupRetentionPeriod' => <integer>,
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'PreferredBackupWindow' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

PurchaseReservedDBInstancesOffering

$result = $client->purchaseReservedDBInstancesOffering([/* ... */]);
$promise = $client->purchaseReservedDBInstancesOfferingAsync([/* ... */]);

Parameter Syntax

$result = $client->purchaseReservedDBInstancesOffering([
    'DBInstanceCount' => <integer>,
    'ReservedDBInstanceId' => '<string>',
    'ReservedDBInstancesOfferingId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ReservedDBInstance' => [
        'CurrencyCode' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceCount' => <integer>,
        'Duration' => <integer>,
        'FixedPrice' => <float>,
        'MultiAZ' => true || false,
        'OfferingType' => '<string>',
        'ProductDescription' => '<string>',
        'RecurringCharges' => [
            [
                'RecurringChargeAmount' => <float>,
                'RecurringChargeFrequency' => '<string>',
            ],
            // ...
        ],
        'ReservedDBInstanceId' => '<string>',
        'ReservedDBInstancesOfferingId' => '<string>',
        'StartTime' => <DateTime>,
        'State' => '<string>',
        'UsagePrice' => <float>,
    ],
]

Result Details

Errors

ReservedDBInstancesOfferingNotFoundFault:

Specified offering does not exist.

ReservedDBInstanceAlreadyExistsFault:

User already has a reservation with the given identifier.

ReservedDBInstanceQuotaExceededFault:

Request would exceed the user's DB Instance quota.

RebootDBInstance

$result = $client->rebootDBInstance([/* ... */]);
$promise = $client->rebootDBInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->rebootDBInstance([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'ForceFailover' => true || false,
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

RemoveSourceIdentifierFromSubscription

$result = $client->removeSourceIdentifierFromSubscription([/* ... */]);
$promise = $client->removeSourceIdentifierFromSubscriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->removeSourceIdentifierFromSubscription([
    'SourceIdentifier' => '<string>', // REQUIRED
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Errors

SubscriptionNotFoundFault:

The subscription name does not exist.

SourceNotFoundFault:

The requested source could not be found.

RemoveTagsFromResource

$result = $client->removeTagsFromResource([/* ... */]);
$promise = $client->removeTagsFromResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->removeTagsFromResource([
    'ResourceName' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

ResetDBParameterGroup

$result = $client->resetDBParameterGroup([/* ... */]);
$promise = $client->resetDBParameterGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->resetDBParameterGroup([
    'DBParameterGroupName' => '<string>', // REQUIRED
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ApplyMethod' => 'immediate|pending-reboot',
            'ApplyType' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
    'ResetAllParameters' => true || false,
]);

Parameter Details

Result Syntax

[
    'DBParameterGroupName' => '<string>',
]

Result Details

Errors

InvalidDBParameterGroupStateFault:

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

RestoreDBInstanceFromDBSnapshot

$result = $client->restoreDBInstanceFromDBSnapshot([/* ... */]);
$promise = $client->restoreDBInstanceFromDBSnapshotAsync([/* ... */]);

Parameter Syntax

$result = $client->restoreDBInstanceFromDBSnapshot([
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'DBInstanceClass' => '<string>',
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBName' => '<string>',
    'DBSnapshotIdentifier' => '<string>', // REQUIRED
    'DBSubnetGroupName' => '<string>',
    'Engine' => '<string>',
    'Iops' => <integer>,
    'LicenseModel' => '<string>',
    'MultiAZ' => true || false,
    'OptionGroupName' => '<string>',
    'Port' => <integer>,
    'PubliclyAccessible' => true || false,
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TdeCredentialArn' => '<string>',
    'TdeCredentialPassword' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceAlreadyExistsFault:

The user already has a DB instance with the given identifier.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

InstanceQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB instances.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

InvalidDBSnapshotStateFault:

The state of the DB snapshot doesn't allow deletion.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

InvalidRestoreFault:

Cannot restore from VPC backup to non-VPC DB instance.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

ProvisionedIopsNotAvailableInAZFault:

Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundFault:

The specified option group could not be found.

StorageTypeNotSupportedFault:

The specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundFault:

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

RestoreDBInstanceToPointInTime

$result = $client->restoreDBInstanceToPointInTime([/* ... */]);
$promise = $client->restoreDBInstanceToPointInTimeAsync([/* ... */]);

Parameter Syntax

$result = $client->restoreDBInstanceToPointInTime([
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'DBInstanceClass' => '<string>',
    'DBName' => '<string>',
    'DBSubnetGroupName' => '<string>',
    'Engine' => '<string>',
    'Iops' => <integer>,
    'LicenseModel' => '<string>',
    'MultiAZ' => true || false,
    'OptionGroupName' => '<string>',
    'Port' => <integer>,
    'PubliclyAccessible' => true || false,
    'RestoreTime' => <integer || string || DateTime>,
    'SourceDBInstanceIdentifier' => '<string>', // REQUIRED
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDBInstanceIdentifier' => '<string>', // REQUIRED
    'TdeCredentialArn' => '<string>',
    'TdeCredentialPassword' => '<string>',
    'UseLatestRestorableTime' => true || false,
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AllocatedStorage' => <integer>,
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CharacterSetName' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageType' => '<string>',
        'TdeCredentialArn' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceAlreadyExistsFault:

The user already has a DB instance with the given identifier.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

InstanceQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB instances.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

PointInTimeRestoreNotEnabledFault:

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

InvalidRestoreFault:

Cannot restore from VPC backup to non-VPC DB instance.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

ProvisionedIopsNotAvailableInAZFault:

Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundFault:

The specified option group could not be found.

StorageTypeNotSupportedFault:

The specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundFault:

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

RevokeDBSecurityGroupIngress

$result = $client->revokeDBSecurityGroupIngress([/* ... */]);
$promise = $client->revokeDBSecurityGroupIngressAsync([/* ... */]);

Parameter Syntax

$result = $client->revokeDBSecurityGroupIngress([
    'CIDRIP' => '<string>',
    'DBSecurityGroupName' => '<string>', // REQUIRED
    'EC2SecurityGroupId' => '<string>',
    'EC2SecurityGroupName' => '<string>',
    'EC2SecurityGroupOwnerId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DBSecurityGroup' => [
        'DBSecurityGroupDescription' => '<string>',
        'DBSecurityGroupName' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupId' => '<string>',
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'IPRanges' => [
            [
                'CIDRIP' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'OwnerId' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

AuthorizationNotFoundFault:

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

InvalidDBSecurityGroupStateFault:

The state of the DB security group doesn't allow deletion.