odb / Client / update_odb_network

update_odb_network

odb.Client.update_odb_network(**kwargs)

Updates properties of a specified ODB network.

See also: AWS API Documentation

Request Syntax

response = client.update_odb_network(
    odbNetworkId='string',
    displayName='string',
    peeredCidrsToBeAdded=[
        'string',
    ],
    peeredCidrsToBeRemoved=[
        'string',
    ],
    s3Access='ENABLED'|'DISABLED',
    zeroEtlAccess='ENABLED'|'DISABLED',
    stsAccess='ENABLED'|'DISABLED',
    kmsAccess='ENABLED'|'DISABLED',
    s3PolicyDocument='string',
    stsPolicyDocument='string',
    kmsPolicyDocument='string',
    crossRegionS3RestoreSourcesToEnable=[
        'string',
    ],
    crossRegionS3RestoreSourcesToDisable=[
        'string',
    ]
)

Parameters:

• odbNetworkId (string) –

  [REQUIRED]

  The unique identifier of the ODB network to update.

• displayName (string) – The new user-friendly name of the ODB network.

• peeredCidrsToBeAdded (list) –

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

  • (string) –

• peeredCidrsToBeRemoved (list) –

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

  • (string) –

• s3Access (string) – Specifies the updated configuration for Amazon S3 access from the ODB network.

• zeroEtlAccess (string) – Specifies the updated configuration for Zero-ETL access from the ODB network.

• stsAccess (string) – The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

• kmsAccess (string) – The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

• s3PolicyDocument (string) – Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

• stsPolicyDocument (string) – The STS policy document that defines permissions for token service usage within the ODB network.

• kmsPolicyDocument (string) – The KMS policy document that defines permissions for key usage within the ODB network.

• crossRegionS3RestoreSourcesToEnable (list) –

  The cross-Region Amazon S3 restore sources to enable for the ODB network.

  • (string) –

• crossRegionS3RestoreSourcesToDisable (list) –

  The cross-Region Amazon S3 restore sources to disable for the ODB network.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
    'statusReason': 'string',
    'odbNetworkId': 'string'
}

Response Structure

• (dict) –

  • displayName (string) –

    The user-friendly name of the ODB network.

  • status (string) –

    The current status of the ODB network.

  • statusReason (string) –

    Additional information about the status of the ODB network.

  • odbNetworkId (string) –

    The unique identifier of the ODB network.

Exceptions

• odb.Client.exceptions.ThrottlingException

• odb.Client.exceptions.ValidationException

• odb.Client.exceptions.ConflictException

• odb.Client.exceptions.AccessDeniedException

• odb.Client.exceptions.InternalServerException

• odb.Client.exceptions.ResourceNotFoundException