Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateOdbNetwork

Updates properties of a specified ODB network.

Request Syntax


{
   "displayName": "string",
   "odbNetworkId": "string",
   "peeredCidrsToBeAdded": [ "string" ],
   "peeredCidrsToBeRemoved": [ "string" ],
   "s3Access": "string",
   "s3PolicyDocument": "string",
   "zeroEtlAccess": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

displayName

The new user-friendly name of the ODB network.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*

Required: No

odbNetworkId

The unique identifier of the ODB network to update.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

Pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Required: Yes

peeredCidrsToBeAdded

The list of CIDR ranges from the peered VPC that allow access to the ODB network.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1024 items.

Required: No

peeredCidrsToBeRemoved

The list of CIDR ranges from the peered VPC to remove from the ODB network.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1024 items.

Required: No

s3Access

Specifies the updated configuration for Amazon S3 access from the ODB network.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

s3PolicyDocument

Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 20480.

Required: No

zeroEtlAccess

Specifies the updated configuration for Zero-ETL access from the ODB network.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax


{
   "displayName": "string",
   "odbNetworkId": "string",
   "status": "string",
   "statusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

displayName

The user-friendly name of the ODB network.

Type: String

odbNetworkId

The unique identifier of the ODB network.

Type: String

status

The current status of the ODB network.

Type: String

statusReason

Additional information about the status of the ODB network.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

retryAfterSeconds: The number of seconds to wait before retrying the request after an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

resourceId: The identifier of the resource that was not found.
resourceType: The type of resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds to wait before retrying the request after being throttled.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

fieldList: A list of fields that failed validation.
reason: The reason why the validation failed.

HTTP Status Code: 400