diff --git a/scaleway-async/scaleway_async/instance/v1/api.py b/scaleway-async/scaleway_async/instance/v1/api.py index fce90fb7c..9f09d4ea3 100644 --- a/scaleway-async/scaleway_async/instance/v1/api.py +++ b/scaleway-async/scaleway_async/instance/v1/api.py @@ -228,7 +228,7 @@ async def get_server_types_availability( ) -> GetServerTypesAvailabilityResponse: """ Get availability. - Get availability for all server types. + Get availability for all Instance types. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: :param page: @@ -262,8 +262,8 @@ async def list_servers_types( page: Optional[int] = None, ) -> ListServersTypesResponse: """ - List server types. - Get server types technical details. + List Instance types. + List available Instance types and their technical details. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: :param page: @@ -298,7 +298,7 @@ async def list_volumes_types( ) -> ListVolumesTypesResponse: """ List volumes types. - Get volumes technical details. + List all volume types and their technical details. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: :param page: @@ -342,19 +342,20 @@ async def list_servers( order: ListServersRequestOrder = ListServersRequestOrder.CREATION_DATE_DESC, ) -> ListServersResponse: """ - List all servers. + List all Instances. + List all Instances in a specified Availability Zone, e.g. `fr-par-1`. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only servers of this organization ID. - :param project: List only servers of this project ID. - :param name: Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo"). - :param private_ip: List servers by private_ip. - :param without_ip: List servers that are not attached to a public IP. - :param commercial_type: List servers of this commercial type. - :param state: List servers in this state. - :param tags: List servers with these exact tags (to filter with several tags, use commas to separate them). - :param private_network: List servers in this Private Network. + :param organization: List only Instances of this Organization ID. + :param project: List only Instances of this Project ID. + :param name: Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). + :param private_ip: List Instances by private_ip. + :param without_ip: List Instances that are not attached to a public IP. + :param commercial_type: List Instances of this commercial type. + :param state: List Instances in this state. + :param tags: List Instances with these exact tags (to filter with several tags, use commas to separate them). + :param private_network: List Instances in this Private Network. :param order: Define the order of the returned servers. :return: :class:`ListServersResponse ` @@ -406,19 +407,20 @@ async def list_servers_all( order: Optional[ListServersRequestOrder] = None, ) -> List[Server]: """ - List all servers. + List all Instances. + List all Instances in a specified Availability Zone, e.g. `fr-par-1`. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only servers of this organization ID. - :param project: List only servers of this project ID. - :param name: Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo"). - :param private_ip: List servers by private_ip. - :param without_ip: List servers that are not attached to a public IP. - :param commercial_type: List servers of this commercial type. - :param state: List servers in this state. - :param tags: List servers with these exact tags (to filter with several tags, use commas to separate them). - :param private_network: List servers in this Private Network. + :param organization: List only Instances of this Organization ID. + :param project: List only Instances of this Project ID. + :param name: Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). + :param private_ip: List Instances by private_ip. + :param without_ip: List Instances that are not attached to a public IP. + :param commercial_type: List Instances of this commercial type. + :param state: List Instances in this state. + :param tags: List Instances with these exact tags (to filter with several tags, use commas to separate them). + :param private_network: List Instances in this Private Network. :param order: Define the order of the returned servers. :return: :class:`List[ListServersResponse] ` @@ -469,44 +471,28 @@ async def _create_server( placement_group: Optional[str] = None, ) -> CreateServerResponse: """ - Create a server. - The `volumes` key is a dictionary composed of the volume position as key and the volume parameters as value. - Depending of the volume parameters, you can achieve different behaviours : - - Create a volume from a snapshot of an image : - Optional : `volume_type`, `size`, `boot`. - If the `size` parameter is not set, the size of the volume will equal the size of the corresponding snapshot of the image. - - Attach an existing volume : - Required : `id`, `name`. - Optional : `boot`. - - Create an empty volume : - Required : `name`, `volume_type`, `size`. - Optional : `organization`, `project`, `boot`. - - Create a volume from a snapshot : - Required : `base_snapshot`, `name`, `volume_type`. - Optional : `organization`, `project`, `boot`. + Create an Instance. + Create a new Instance of the specified commercial type in the specified zone. Pay attention to the volumes parameter, which takes an object which can be used in different ways to achieve different behaviors. + Get more information in the [Technical Information](#technical-information) section of the introduction. :param zone: Zone to target. If none is passed will use default zone from the config. - :param name: The server name. - :param dynamic_ip_required: Define if a dynamic IP is required for the instance. - :param commercial_type: Define the server commercial type (i.e. GP1-S). - :param image: The server image ID or label. - :param volumes: The volumes attached to the server. + :param name: Instance name. + :param dynamic_ip_required: Define if a dynamic IP is required for the Instance. + :param commercial_type: Define the Instance commercial type (i.e. GP1-S). + :param image: Instance image ID or label. + :param volumes: Volumes attached to the server. :param enable_ipv6: True if IPv6 is enabled on the server. - :param public_ip: The ID of the reserved IP to attach to the server. - :param boot_type: The boot type to use. - :param bootscript: The bootscript ID to use when `boot_type` is set to `bootscript`. - :param organization: The server organization ID. + :param public_ip: ID of the reserved IP to attach to the server. + :param boot_type: Boot type to use. + :param bootscript: Bootscript ID to use when `boot_type` is set to `bootscript`. + :param organization: Instance Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param project: The server project ID. + :param project: Instance Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The server tags. - :param security_group: The security group ID. - :param placement_group: Placement group ID if server must be part of a placement group. + :param tags: Instance tags. + :param security_group: Security group ID. + :param placement_group: Placement group ID if Instance must be part of a placement group. :return: :class:`CreateServerResponse ` Usage: @@ -556,8 +542,8 @@ async def delete_server( zone: Optional[Zone] = None, ) -> Optional[None]: """ - Delete a server. - Delete a server with the given ID. + Delete an Instance. + Delete the Instance with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param server_id: @@ -585,10 +571,10 @@ async def get_server( zone: Optional[Zone] = None, ) -> GetServerResponse: """ - Get a server. - Get the details of a specified Server. + Get an Instance. + Get the details of a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server you want to get. + :param server_id: UUID of the Instance you want to get. :return: :class:`GetServerResponse ` Usage: @@ -724,20 +710,21 @@ async def _update_server( private_nics: Optional[List[PrivateNIC]] = None, ) -> UpdateServerResponse: """ - Update a server. + Update an Instance. + Update the Instance information, such as name, boot mode, or tags. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. - :param name: Name of the server. + :param server_id: UUID of the Instance. + :param name: Name of the Instance. :param boot_type: - :param tags: Tags of the server. + :param tags: Tags of the Instance. :param volumes: :param bootscript: :param dynamic_ip_required: :param enable_ipv6: :param protected: :param security_group: - :param placement_group: Placement group ID if server must be part of a placement group. - :param private_nics: The server private NICs. + :param placement_group: Placement group ID if Instance must be part of a placement group. + :param private_nics: Instance private NICs. :return: :class:`UpdateServerResponse ` Usage: @@ -782,8 +769,8 @@ async def list_server_actions( zone: Optional[Zone] = None, ) -> ListServerActionsResponse: """ - List server actions. - List all actions that can currently be performed on a server. + List Instance actions. + List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :param server_id: :return: :class:`ListServerActionsResponse ` @@ -816,12 +803,23 @@ async def server_action( ) -> ServerActionResponse: """ Perform action. - Perform power related actions on a server. Be wary that when terminating a server, all the attached volumes (local *and* block storage) are deleted. So, if you want to keep your local volumes, you must use the `archive` action instead of `terminate`. And if you want to keep block-storage volumes, **you must** detach it beforehand you issue the `terminate` call. For more information, read the [Volumes](#volumes-7e8a39) documentation. - :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. - :param action: The action to perform on the server. - :param name: The name of the backup you want to create. - The name of the backup you want to create. + Perform an action on an Instance. + Available actions are: + * `poweron`: Start a stopped Instance. + * `poweroff`: Fully stop the Instance and release the hypervisor slot. + * `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor. + * `reboot`: Stop the instance and restart it. + * `backup`: Create an image with all the volumes of an Instance. + * `terminate`: Delete the Instance along with all attached volumes. + + Keep in mind that terminating an Instance will result in the deletion of all attached volumes, including local and block storage. + If you want to preserve your local volumes, you should use the `archive` action instead of `terminate`. Similarly, if you want to keep your block storage volumes, you must first detach them before issuing the `terminate` command. + For more information, read the [Volumes](#volumes-7e8a39) documentation. + :param zone: Zone to target. If none is passed will use default zone from the config. + :param server_id: UUID of the Instance. + :param action: Action to perform on the Instance. + :param name: Name of the backup you want to create. + Name of the backup you want to create. This field should only be specified when performing a backup action. :param volumes: For each volume UUID, the snapshot parameters of the volume. For each volume UUID, the snapshot parameters of the volume. @@ -866,9 +864,9 @@ async def list_server_user_data( ) -> ListServerUserDataResponse: """ List user data. - List all user data keys registered on a given server. + List all user data keys registered on a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. + :param server_id: UUID of the Instance. :return: :class:`ListServerUserDataResponse ` Usage: @@ -897,9 +895,9 @@ async def delete_server_user_data( ) -> Optional[None]: """ Delete user data. - Delete the given key from a server user data. + Delete the specified key from an Instance's user data. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. + :param server_id: UUID of the Instance. :param key: Key of the user data to delete. Usage: @@ -937,8 +935,8 @@ async def list_images( tags: Optional[str] = None, ) -> ListImagesResponse: """ - List instance images. - List all images available in an account. + List Instance images. + List all existing Instance images. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -990,8 +988,8 @@ async def list_images_all( tags: Optional[str] = None, ) -> List[Image]: """ - List instance images. - List all images available in an account. + List Instance images. + List all existing Instance images. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -1033,8 +1031,8 @@ async def get_image( zone: Optional[Zone] = None, ) -> GetImageResponse: """ - Get an instance image. - Get details of an image with the given ID. + Get an Instance image. + Get details of an image with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param image_id: UUID of the image you want to get. :return: :class:`GetImageResponse ` @@ -1071,7 +1069,8 @@ async def create_image( public: Optional[bool] = None, ) -> CreateImageResponse: """ - Create an instance image. + Create an Instance image. + Create an Instance image from the specified snapshot ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the image. :param root_volume: UUID of the snapshot. @@ -1084,7 +1083,7 @@ async def create_image( :param project: Project ID of the image. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the image. + :param tags: Tags of the image. :param public: True to create a public image. :return: :class:`CreateImageResponse ` @@ -1209,8 +1208,8 @@ async def delete_image( zone: Optional[Zone] = None, ) -> Optional[None]: """ - Delete an instance image. - Delete the image with the given ID. + Delete an Instance image. + Delete the image with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param image_id: UUID of the image you want to delete. @@ -1244,6 +1243,7 @@ async def list_snapshots( ) -> ListSnapshotsResponse: """ List snapshots. + List all snapshots of an Organization in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -1290,6 +1290,7 @@ async def list_snapshots_all( ) -> List[Snapshot]: """ List snapshots. + List all snapshots of an Organization in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -1335,18 +1336,19 @@ async def create_snapshot( size: Optional[int] = None, ) -> CreateSnapshotResponse: """ - Create a snapshot from a given volume or from a QCOW2 file. + Create a snapshot from a specified volume or from a QCOW2 file. + Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the snapshot. :param volume_id: UUID of the volume. - :param tags: The tags of the snapshot. + :param tags: Tags of the snapshot. :param organization: Organization ID of the snapshot. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :param project: Project ID of the snapshot. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param volume_type: The volume type of the snapshot. + :param volume_type: Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used. :param bucket: Bucket name for snapshot imports. @@ -1393,7 +1395,7 @@ async def get_snapshot( ) -> GetSnapshotResponse: """ Get a snapshot. - Get details of a snapshot with the given ID. + Get details of a snapshot with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param snapshot_id: UUID of the snapshot you want to get. :return: :class:`GetSnapshotResponse ` @@ -1500,7 +1502,7 @@ async def delete_snapshot( ) -> Optional[None]: """ Delete a snapshot. - Delete the snapshot with the given ID. + Delete the snapshot with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param snapshot_id: UUID of the snapshot you want to delete. @@ -1531,9 +1533,9 @@ async def export_snapshot( ) -> ExportSnapshotResponse: """ Export a snapshot. - Export a snapshot to a given S3 bucket in the same region. + Export a snapshot to a specified S3 bucket in the same region. :param zone: Zone to target. If none is passed will use default zone from the config. - :param snapshot_id: The snapshot ID. + :param snapshot_id: Snapshot ID. :param bucket: S3 bucket name. :param key: S3 object key. :return: :class:`ExportSnapshotResponse ` @@ -1582,12 +1584,13 @@ async def list_volumes( ) -> ListVolumesResponse: """ List volumes. + List volumes in the specified Availability Zone. You can filter the output by volume type. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_type: Filter by volume type. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: Filter volume by organization ID. - :param project: Filter volume by project ID. + :param organization: Filter volume by Organization ID. + :param project: Filter volume by Project ID. :param tags: Filter volumes with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter volume by name (for eg. "vol" will return "myvolume" but not "data"). :return: :class:`ListVolumesResponse ` @@ -1631,12 +1634,13 @@ async def list_volumes_all( ) -> List[Volume]: """ List volumes. + List volumes in the specified Availability Zone. You can filter the output by volume type. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_type: Filter by volume type. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: Filter volume by organization ID. - :param project: Filter volume by project ID. + :param organization: Filter volume by Organization ID. + :param project: Filter volume by Project ID. :param tags: Filter volumes with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter volume by name (for eg. "vol" will return "myvolume" but not "data"). :return: :class:`List[ListVolumesResponse] ` @@ -1678,23 +1682,24 @@ async def create_volume( ) -> CreateVolumeResponse: """ Create a volume. + Create a volume of a specified type in an Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. - :param name: The volume name. - :param organization: The volume organization ID. + :param name: Volume name. + :param organization: Volume Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param project: The volume project ID. + :param project: Volume Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The volume tags. - :param volume_type: The volume type. - :param size: The volume disk size, must be a multiple of 512. + :param tags: Volume tags. + :param volume_type: Volume type. + :param size: Volume disk size, must be a multiple of 512. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. - :param base_volume: The ID of the volume on which this volume will be based. + :param base_volume: ID of the volume on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. - :param base_snapshot: The ID of the snapshot on which this volume will be based. + :param base_snapshot: ID of the snapshot on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. :return: :class:`CreateVolumeResponse ` @@ -1737,7 +1742,7 @@ async def get_volume( ) -> GetVolumeResponse: """ Get a volume. - Get details of a volume with the given ID. + Get details of a volume with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_id: UUID of the volume you want to get. :return: :class:`GetVolumeResponse ` @@ -1770,12 +1775,12 @@ async def update_volume( ) -> UpdateVolumeResponse: """ Update a volume. - Replace name and/or size properties of given ID volume with the given value(s). Any volume name can be changed while, for now, only `b_ssd` volume growing is supported. + Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_id: UUID of the volume. - :param name: The volume name. - :param tags: The tags of the volume. - :param size: The volume disk size, must be a multiple of 512. + :param name: Volume name. + :param tags: Tags of the volume. + :param size: Volume disk size, must be a multiple of 512. :return: :class:`UpdateVolumeResponse ` Usage: @@ -1813,7 +1818,7 @@ async def delete_volume( ) -> Optional[None]: """ Delete a volume. - Delete the volume with the given ID. + Delete the volume with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_id: UUID of the volume you want to delete. @@ -1848,11 +1853,11 @@ async def list_security_groups( ) -> ListSecurityGroupsResponse: """ List security groups. - List all security groups available in an account. + List all existing security groups. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the security group. - :param organization: The security group organization ID. - :param project: The security group project ID. + :param organization: Security group Organization ID. + :param project: Security group Project ID. :param tags: List security groups with these exact tags (to filter with several tags, use commas to separate them). :param project_default: Filter security groups with this value for project_default. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -1898,11 +1903,11 @@ async def list_security_groups_all( ) -> List[SecurityGroup]: """ List security groups. - List all security groups available in an account. + List all existing security groups. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the security group. - :param organization: The security group organization ID. - :param project: The security group project ID. + :param organization: Security group Organization ID. + :param project: Security group Project ID. :param tags: List security groups with these exact tags (to filter with several tags, use commas to separate them). :param project_default: Filter security groups with this value for project_default. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -1949,6 +1954,7 @@ async def create_security_group( ) -> CreateSecurityGroupResponse: """ Create a security group. + Create a security group with a specified name and description. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the security group. :param description: Description of the security group. @@ -1958,11 +1964,11 @@ async def create_security_group( :param project: Project ID the security group belong to. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the security group. - :param organization_default: Whether this security group becomes the default security group for new instances. + :param tags: Tags of the security group. + :param organization_default: Defines whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. - :param project_default: Whether this security group becomes the default security group for new instances. + :param project_default: Whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. :param stateful: Whether the security group is stateful or not. @@ -2017,7 +2023,7 @@ async def get_security_group( ) -> GetSecurityGroupResponse: """ Get a security group. - Get the details of a Security Group with the given ID. + Get the details of a security group with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group you want to get. :return: :class:`GetSecurityGroupResponse ` @@ -2049,6 +2055,7 @@ async def delete_security_group( ) -> Optional[None]: """ Delete a security group. + Delete a security group with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group you want to delete. @@ -2095,20 +2102,20 @@ async def _set_security_group( Update a security group. Replace all security group properties with a security group message. :param zone: Zone to target. If none is passed will use default zone from the config. - :param id: The ID of the security group (will be ignored). - :param name: The name of the security group. - :param tags: The tags of the security group. - :param creation_date: The creation date of the security group (will be ignored). - :param modification_date: The modification date of the security group (will be ignored). - :param description: The description of the security group. + :param id: ID of the security group (will be ignored). + :param name: Name of the security group. + :param tags: Tags of the security group. + :param creation_date: Creation date of the security group (will be ignored). + :param modification_date: Modification date of the security group (will be ignored). + :param description: Description of the security group. :param enable_default_security: True to block SMTP on IPv4 and IPv6. - :param inbound_default_policy: The default inbound policy. - :param outbound_default_policy: The default outbound policy. - :param organization: The security groups organization ID. - :param project: The security group project ID. + :param inbound_default_policy: Default inbound policy. + :param outbound_default_policy: Default outbound policy. + :param organization: Security groups Organization ID. + :param project: Security group Project ID. :param organization_default: Please use project_default instead. - :param project_default: True use this security group for future instances created in this project. - :param servers: The servers attached to this security group. + :param project_default: True use this security group for future Instances created in this project. + :param servers: Instances attached to this security group. :param stateful: True to set the security group as stateful. :return: :class:`_SetSecurityGroupResponse <_SetSecurityGroupResponse>` @@ -2196,6 +2203,7 @@ async def list_security_group_rules( ) -> ListSecurityGroupRulesResponse: """ List rules. + List the rules of the a specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -2235,6 +2243,7 @@ async def list_security_group_rules_all( ) -> List[SecurityGroupRule]: """ List rules. + List the rules of the a specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -2275,15 +2284,16 @@ async def create_security_group_rule( ) -> CreateSecurityGroupRuleResponse: """ Create rule. + Create a rule in the specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group. :param protocol: :param direction: :param action: :param ip_range: - :param dest_port_from: The beginning of the range of ports to apply this rule to (inclusive). - :param dest_port_to: The end of the range of ports to apply this rule to (inclusive). - :param position: The position of this rule in the security group rules list. + :param dest_port_from: Beginning of the range of ports to apply this rule to (inclusive). + :param dest_port_to: End of the range of ports to apply this rule to (inclusive). + :param position: Position of this rule in the security group rules list. :param editable: Indicates if this rule is editable (will be ignored). :return: :class:`CreateSecurityGroupRuleResponse ` @@ -2335,7 +2345,7 @@ async def set_security_group_rules( ) -> SetSecurityGroupRulesResponse: """ Update all the rules of a security group. - Replaces the rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request. + Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group to update the rules on. :param rules: List of rules to update in the security group. @@ -2377,7 +2387,7 @@ async def delete_security_group_rule( ) -> Optional[None]: """ Delete rule. - Delete a security group rule with the given ID. + Delete a security group rule with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: :param security_group_rule_id: @@ -2416,7 +2426,7 @@ async def get_security_group_rule( ) -> GetSecurityGroupRuleResponse: """ Get rule. - Get details of a security group rule with the given ID. + Get details of a security group rule with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: :param security_group_rule_id: @@ -2465,6 +2475,7 @@ async def _set_security_group_rule( ) -> _SetSecurityGroupRuleResponse: """ Update security group rule. + Update the rule of a specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: :param security_group_rule_id: @@ -2541,12 +2552,12 @@ async def list_placement_groups( ) -> ListPlacementGroupsResponse: """ List placement groups. - List all placement groups. + List all placement groups in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only placement groups of this organization ID. - :param project: List only placement groups of this project ID. + :param organization: List only placement groups of this Organization ID. + :param project: List only placement groups of this Project ID. :param tags: List placement groups with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo"). :return: :class:`ListPlacementGroupsResponse ` @@ -2588,12 +2599,12 @@ async def list_placement_groups_all( ) -> List[PlacementGroup]: """ List placement groups. - List all placement groups. + List all placement groups in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only placement groups of this organization ID. - :param project: List only placement groups of this project ID. + :param organization: List only placement groups of this Organization ID. + :param project: List only placement groups of this Project ID. :param tags: List placement groups with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo"). :return: :class:`List[ListPlacementGroupsResponse] ` @@ -2632,7 +2643,7 @@ async def create_placement_group( ) -> CreatePlacementGroupResponse: """ Create a placement group. - Create a new placement group. + Create a new placement group in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the placement group. :param organization: Organization ID of the placement group. @@ -2641,9 +2652,9 @@ async def create_placement_group( :param project: Project ID of the placement group. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the placement group. - :param policy_mode: The operating mode of the placement group. - :param policy_type: The policy type of the placement group. + :param tags: Tags of the placement group. + :param policy_mode: Operating mode of the placement group. + :param policy_type: Policy type of the placement group. :return: :class:`CreatePlacementGroupResponse ` Usage: @@ -2685,7 +2696,7 @@ async def get_placement_group( ) -> GetPlacementGroupResponse: """ Get a placement group. - Get the given placement group. + Get the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: UUID of the placement group you want to get. :return: :class:`GetPlacementGroupResponse ` @@ -2723,7 +2734,7 @@ async def set_placement_group( ) -> SetPlacementGroupResponse: """ Set placement group. - Set all parameters of the given placement group. + Set all parameters of the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: :param name: @@ -2783,13 +2794,13 @@ async def update_placement_group( ) -> UpdatePlacementGroupResponse: """ Update a placement group. - Update one or more parameter of the given placement group. + Update one or more parameter of the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: UUID of the placement group. :param name: Name of the placement group. - :param tags: The tags of the placement group. - :param policy_mode: The operating mode of the placement group. - :param policy_type: The policy type of the placement group. + :param tags: Tags of the placement group. + :param policy_mode: Operating mode of the placement group. + :param policy_type: Policy type of the placement group. :return: :class:`UpdatePlacementGroupResponse ` Usage: @@ -2829,7 +2840,7 @@ async def delete_placement_group( zone: Optional[Zone] = None, ) -> Optional[None]: """ - Delete the given placement group. + Delete the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: UUID of the placement group you want to delete. @@ -2860,9 +2871,9 @@ async def get_placement_group_servers( ) -> GetPlacementGroupServersResponse: """ Get placement group servers. - Get all servers belonging to the given placement group. + Get all Instances belonging to the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. - :param placement_group_id: + :param placement_group_id: UUID of the placement group you want to get. :return: :class:`GetPlacementGroupServersResponse ` Usage: @@ -2888,21 +2899,24 @@ async def set_placement_group_servers( self, *, placement_group_id: str, + servers: List[str], zone: Optional[Zone] = None, - servers: Optional[List[str]] = None, ) -> SetPlacementGroupServersResponse: """ Set placement group servers. - Set all servers belonging to the given placement group. + Set all Instances belonging to the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. - :param placement_group_id: - :param servers: + :param placement_group_id: UUID of the placement group you want to set. + :param servers: An array of the Instances' UUIDs you want to configure. :return: :class:`SetPlacementGroupServersResponse ` Usage: :: - result = await api.set_placement_group_servers(placement_group_id="example") + result = await api.set_placement_group_servers( + placement_group_id="example", + servers=["example"], + ) """ param_zone = validate_path_param("zone", zone or self.client.default_zone) @@ -2916,8 +2930,8 @@ async def set_placement_group_servers( body=marshal_SetPlacementGroupServersRequest( SetPlacementGroupServersRequest( placement_group_id=placement_group_id, - zone=zone, servers=servers, + zone=zone, ), self.client, ), @@ -2935,10 +2949,10 @@ async def update_placement_group_servers( ) -> UpdatePlacementGroupServersResponse: """ Update placement group servers. - Update all servers belonging to the given placement group. + Update all Instances belonging to the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. - :param placement_group_id: UUID of the placement group. - :param servers: + :param placement_group_id: UUID of the placement group you want to update. + :param servers: An array of the Instances' UUIDs you want to configure. :return: :class:`UpdatePlacementGroupServersResponse ` Usage: @@ -2984,9 +2998,10 @@ async def list_ips( ) -> ListIpsResponse: """ List all flexible IPs. + List all flexible IPs in a specified zone. :param zone: Zone to target. If none is passed will use default zone from the config. - :param project: The project ID the IPs are reserved in. - :param organization: The organization ID the IPs are reserved in. + :param project: Project ID in which the IPs are reserved. + :param organization: Organization ID in which the IPs are reserved. :param tags: Filter IPs with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter on the IP address (Works as a LIKE operation on the IP address). :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -3030,9 +3045,10 @@ async def list_ips_all( ) -> List[Ip]: """ List all flexible IPs. + List all flexible IPs in a specified zone. :param zone: Zone to target. If none is passed will use default zone from the config. - :param project: The project ID the IPs are reserved in. - :param organization: The organization ID the IPs are reserved in. + :param project: Project ID in which the IPs are reserved. + :param organization: Organization ID in which the IPs are reserved. :param tags: Filter IPs with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter on the IP address (Works as a LIKE operation on the IP address). :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -3071,15 +3087,16 @@ async def create_ip( ) -> CreateIpResponse: """ Reserve a flexible IP. + Reserve a flexible IP and attach it to the specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param organization: The organization ID the IP is reserved in. + :param organization: Organization ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param project: The project ID the IP is reserved in. + :param project: Project ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the IP. - :param server: UUID of the server you want to attach the IP to. + :param tags: Tags of the IP. + :param server: UUID of the Instance you want to attach the IP to. :return: :class:`CreateIpResponse ` Usage: @@ -3116,9 +3133,9 @@ async def get_ip( ) -> GetIpResponse: """ Get a flexible IP. - Get details of an IP with the given ID or address. + Get details of an IP with the specified ID or address. :param zone: Zone to target. If none is passed will use default zone from the config. - :param ip: The IP ID or address to get. + :param ip: IP ID or address to get. :return: :class:`GetIpResponse ` Usage: @@ -3149,6 +3166,7 @@ async def update_ip( ) -> UpdateIpResponse: """ Update a flexible IP. + Update a flexible IP in the specified zone with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param ip: IP ID or IP address. :param reverse: Reverse domain name. @@ -3191,9 +3209,9 @@ async def delete_ip( ) -> Optional[None]: """ Delete a flexible IP. - Delete the IP with the given ID. + Delete the IP with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. - :param ip: The ID or the address of the IP to delete. + :param ip: ID or address of the IP to delete. Usage: :: @@ -3223,10 +3241,10 @@ async def list_private_ni_cs( ) -> ListPrivateNICsResponse: """ List all private NICs. - List all private NICs of a given server. + List all private NICs of a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param tags: The private NIC tags. + :param server_id: Instance to which the private NIC is attached. + :param tags: Private NIC tags. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. :return: :class:`ListPrivateNICsResponse ` @@ -3264,10 +3282,10 @@ async def list_private_ni_cs_all( ) -> List[PrivateNIC]: """ List all private NICs. - List all private NICs of a given server. + List all private NICs of a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param tags: The private NIC tags. + :param server_id: Instance to which the private NIC is attached. + :param tags: Private NIC tags. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. :return: :class:`List[ListPrivateNICsResponse] ` @@ -3300,11 +3318,11 @@ async def create_private_nic( tags: Optional[List[str]] = None, ) -> CreatePrivateNICResponse: """ - Create a private NIC connecting a server to a private network. + Create a private NIC connecting an Instance to a Private Network. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server the private NIC will be attached to. + :param server_id: UUID of the Instance the private NIC will be attached to. :param private_network_id: UUID of the private network where the private NIC will be attached. - :param tags: The private NIC tags. + :param tags: Private NIC tags. :return: :class:`CreatePrivateNICResponse ` Usage: @@ -3347,8 +3365,8 @@ async def get_private_nic( Get a private NIC. Get private NIC properties. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param private_nic_id: The private NIC unique ID. + :param server_id: Instance to which the private NIC is attached. + :param private_nic_id: Private NIC unique ID. :return: :class:`GetPrivateNICResponse ` Usage: @@ -3382,10 +3400,10 @@ async def update_private_nic( ) -> PrivateNIC: """ Update a private NIC. - Update one or more parameter/s to a given private NIC. + Update one or more parameter(s) of a specified private NIC. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server the private NIC will be attached to. - :param private_nic_id: The private NIC unique ID. + :param server_id: UUID of the Instance the private NIC will be attached to. + :param private_nic_id: Private NIC unique ID. :param tags: Tags used to select private NIC/s. :return: :class:`PrivateNIC ` @@ -3429,8 +3447,8 @@ async def delete_private_nic( """ Delete a private NIC. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param private_nic_id: The private NIC unique ID. + :param server_id: Instance to which the private NIC is attached. + :param private_nic_id: Private NIC unique ID. Usage: :: @@ -3552,7 +3570,7 @@ async def get_bootscript( ) -> GetBootscriptResponse: """ Get bootscripts. - Get details of a bootscript with the given ID. + Get details of a bootscript with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param bootscript_id: :return: :class:`GetBootscriptResponse ` diff --git a/scaleway-async/scaleway_async/instance/v1/types.py b/scaleway-async/scaleway_async/instance/v1/types.py index e4a42b41b..ff7422e20 100644 --- a/scaleway-async/scaleway_async/instance/v1/types.py +++ b/scaleway-async/scaleway_async/instance/v1/types.py @@ -233,42 +233,42 @@ class Bootscript: bootcmdargs: str """ - The bootscript arguments. + Bootscript arguments. """ default: bool """ - Dispmay if the bootscript is the default bootscript if no other boot option is configured. + Display if the bootscript is the default bootscript (if no other boot option is configured). """ dtb: str """ - Provide information regarding a Device Tree Binary (dtb) for use with C1 servers. + Provide information regarding a Device Tree Binary (DTB) for use with C1 servers. """ id: str """ - The bootscript ID. + Bootscript ID. """ initrd: str """ - The initrd (initial ramdisk) configuration. + Initrd (initial ramdisk) configuration. """ kernel: str """ - The server kernel version. + Instance kernel version. """ organization: str """ - The bootscript organization ID. + Bootscript Organization ID. """ project: str """ - The bootscript project ID. + Bootscript Project ID. """ public: bool @@ -278,17 +278,17 @@ class Bootscript: title: str """ - The bootscript title. + Bootscript title. """ arch: Arch """ - The bootscript arch. + Bootscript architecture. """ zone: Zone """ - The zone in which is the bootscript. + Zone in which the bootscript is located. """ @@ -404,7 +404,14 @@ class GetPlacementGroupResponse: @dataclass class GetPlacementGroupServersResponse: + """ + Get placement group servers response. + """ + servers: List[PlacementGroupServer] + """ + Instances attached to the placement group. + """ @dataclass @@ -629,12 +636,12 @@ class ListServersResponse: total_count: int """ - Total number of servers. + Total number of Instances. """ servers: List[Server] """ - List of servers. + List of Instances. """ @@ -646,12 +653,12 @@ class ListServersTypesResponse: total_count: int """ - Total number of server types. + Total number of Instance types. """ servers: Dict[str, ServerType] """ - List of server types. + List of Instance types. """ @@ -714,32 +721,32 @@ class PlacementGroup: id: str """ - The placement group unique ID. + Placement group unique ID. """ name: str """ - The placement group name. + Placement group name. """ organization: str """ - The placement group organization ID. + Placement group Organization ID. """ project: str """ - The placement group project ID. + Placement group Project ID. """ tags: List[str] """ - The placement group tags. + Placement group tags. """ policy_mode: PlacementGroupPolicyMode """ - Select the failling mode when the placement cannot be respected, either optional or enforced. + Select the failure mode when the placement cannot be respected, either optional or enforced. """ policy_type: PlacementGroupPolicyType @@ -754,17 +761,30 @@ class PlacementGroup: zone: Zone """ - The zone in which is the placement group. + Zone in which the placement group is located. """ @dataclass class PlacementGroupServer: + """ + Placement group server. + """ + id: str + """ + Instance UUID. + """ name: str + """ + Instance name. + """ policy_respected: bool + """ + Defines whether the placement group policy is respected (either 1 or 0). + """ @dataclass @@ -775,32 +795,32 @@ class PrivateNIC: id: str """ - The private NIC unique ID. + Private NIC unique ID. """ server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ private_network_id: str """ - The private network where the private NIC is attached. + Private Network the private NIC is attached to. """ mac_address: str """ - The private NIC MAC address. + Private NIC MAC address. """ state: PrivateNICState """ - The private NIC state. + Private NIC state. """ tags: List[str] """ - The private NIC tags. + Private NIC tags. """ @@ -812,17 +832,17 @@ class SecurityGroup: id: str """ - The security groups' unique ID. + Security group unique ID. """ name: str """ - The security groups name. + Security group name. """ description: str """ - The security groups description. + Security group description. """ enable_default_security: bool @@ -832,58 +852,58 @@ class SecurityGroup: inbound_default_policy: SecurityGroupPolicy """ - The default inbound policy. + Default inbound policy. """ outbound_default_policy: SecurityGroupPolicy """ - The default outbound policy. + Default outbound policy. """ organization: str """ - The security groups organization ID. + Security group Organization ID. """ project: str """ - The security group project ID. + Security group Project ID. """ tags: List[str] """ - The security group tags. + Security group tags. """ organization_default: Optional[bool] """ - True if it is your default security group for this organization ID. + True if it is your default security group for this Organization ID. :deprecated """ project_default: bool """ - True if it is your default security group for this project ID. + True if it is your default security group for this Project ID. """ creation_date: Optional[datetime] """ - The security group creation date. + Security group creation date. """ modification_date: Optional[datetime] """ - The security group modification date. + Security group modification date. """ servers: List[ServerSummary] """ - List of servers attached to this security group. + List of Instances attached to this security group. """ stateful: bool """ - True if the security group is stateful. + Defines whether the security group is stateful. """ state: SecurityGroupState @@ -893,7 +913,7 @@ class SecurityGroup: zone: Zone """ - The zone in which is the security group. + Zone in which the security group is located. """ @@ -942,42 +962,42 @@ class Server: id: str """ - The server unique ID. + Instance unique ID. """ name: str """ - The server name. + Instance name. """ organization: str """ - The server organization ID. + Instance Organization ID. """ project: str """ - The server project ID. + Instance Project ID. """ allowed_actions: List[ServerAction] """ - Provide as list of allowed actions on the server. + List of allowed actions on the Instance. """ tags: List[str] """ - The server associated tags. + Tags associated with the Instance. """ commercial_type: str """ - The server commercial type (eg. GP1-M). + Instance commercial type (eg. GP1-M). """ creation_date: Optional[datetime] """ - The server creation date. + Instance creation date. """ dynamic_ip_required: bool @@ -992,22 +1012,22 @@ class Server: hostname: str """ - The server host name. + Instance host name. """ image: Optional[Image] """ - Provide information on the server image. + Information about the Instance image. """ protected: bool """ - The server protection option is activated. + Defines whether the Instance protection option is activated. """ private_ip: Optional[str] """ - The server private IP address. + Private IP address of the Instance. """ public_ip: Optional[ServerIp] @@ -1017,73 +1037,73 @@ class Server: modification_date: Optional[datetime] """ - The server modification date. + Instance modification date. """ state: ServerState """ - The server state. + Instance state. """ location: Optional[ServerLocation] """ - The server location. + Instance location. """ ipv6: Optional[ServerIpv6] """ - The server IPv6 address. + Instance IPv6 address. """ bootscript: Optional[Bootscript] """ - The server bootscript. + Instance bootscript. :deprecated """ boot_type: BootType """ - The server boot type. + Instance boot type. """ volumes: Dict[str, VolumeServer] """ - The server volumes. + Instance volumes. """ security_group: Optional[SecurityGroupSummary] """ - The server security group. + Instance security group. """ maintenances: List[ServerMaintenance] """ - The server planned maintenances. + Instance planned maintenance. """ state_detail: str """ - The server state_detail. + Detailed information about the Instance state. """ arch: Arch """ - The server arch. + Instance architecture. """ placement_group: Optional[PlacementGroup] """ - The server placement group. + Instance placement group. """ private_nics: List[PrivateNIC] """ - The server private NICs. + Instance private NICs. """ zone: Zone """ - The zone in which is the server. + Zone in which the Instance is located. """ @@ -1095,8 +1115,8 @@ class ServerActionRequestVolumeBackupTemplate: volume_type: SnapshotVolumeType """ - The snapshot's volume type. - Overrides the volume_type of the snapshot for this volume. + Snapshot's volume type. + Overrides the `volume_type` of the snapshot for this volume. If omitted, the volume type of the original volume will be used. """ @@ -1114,12 +1134,12 @@ class ServerIp: id: str """ - The unique ID of the IP address. + Unique ID of the IP address. """ address: str """ - The server public IPv4 IP-Address. + Instance public IPv4 IP-Address. """ dynamic: bool @@ -1136,17 +1156,17 @@ class ServerIpv6: address: str """ - The server IPv6 IP-Address. + Instance IPv6 IP-Address. """ gateway: str """ - The IPv6 IP-addresses gateway. + IPv6 IP-addresses gateway. """ netmask: str """ - The IPv6 IP-addresses CIDR netmask. + IPv6 IP-addresses CIDR netmask. """ @@ -1194,7 +1214,7 @@ class ServerType: alt_names: List[str] """ - Alternative instance name if any. + Alternative Instance name, if any. """ per_volume_constraint: Optional[ServerTypeVolumeConstraintsByType] @@ -1229,12 +1249,12 @@ class ServerType: baremetal: bool """ - True if it is a baremetal instance. + True if it is a baremetal Instance. """ network: Optional[ServerTypeNetwork] """ - Network available for the instance. + Network available for the Instance. """ capabilities: Optional[ServerTypeCapabilities] @@ -1251,7 +1271,7 @@ class ServerTypeCapabilities: block_storage: Optional[bool] """ - True if server supports block storage. + Defines whether the Instance supports block storage. """ boot_types: List[BootType] @@ -1340,7 +1360,14 @@ class SetPlacementGroupResponse: @dataclass class SetPlacementGroupServersResponse: + """ + Set placement group servers response. + """ + servers: List[PlacementGroupServer] + """ + Instances attached to the placement group. + """ @dataclass @@ -1371,7 +1398,7 @@ class SetSecurityGroupRulesRequestRule: ip_range: str """ - The range of IP address this rules applies to. + Range of IP addresses these rules apply to. """ dest_port_from: Optional[int] @@ -1413,67 +1440,67 @@ class Snapshot: id: str """ - The snapshot ID. + Snapshot ID. """ name: str """ - The snapshot name. + Snapshot name. """ organization: str """ - The snapshot organization ID. + Snapshot Organization ID. """ project: str """ - The snapshot project ID. + Snapshot Project ID. """ tags: List[str] """ - The snapshot tags. + Snapshot tags. """ volume_type: VolumeVolumeType """ - The snapshot volume type. + Snapshot volume type. """ size: int """ - The snapshot size. + Snapshot size. """ state: SnapshotState """ - The snapshot state. + Snapshot state. """ base_volume: Optional[SnapshotBaseVolume] """ - The volume on which the snapshot is based on. + Volume on which the snapshot is based on. """ creation_date: Optional[datetime] """ - The snapshot creation date. + Snapshot creation date. """ modification_date: Optional[datetime] """ - The snapshot modification date. + Snapshot modification date. """ zone: Zone """ - The snapshot zone. + Snapshot zone. """ error_reason: Optional[str] """ - The reason for the failed snapshot import. + Reason for the failed snapshot import. """ @@ -1485,12 +1512,12 @@ class SnapshotBaseVolume: id: str """ - The volume ID on which the snapshot is based on. + Volume ID on which the snapshot is based. """ name: str """ - The volume name on which the snapshot is based on. + Volume name on which the snapshot is based on. """ @@ -1502,32 +1529,32 @@ class Task: id: str """ - The unique ID of the task. + Unique ID of the task. """ description: str """ - The description of the task. + Description of the task. """ progress: int """ - The progress of the task in percent. + Progress of the task in percent. """ started_at: Optional[datetime] """ - The task start date. + Task start date. """ terminated_at: Optional[datetime] """ - The task end date. + Task end date. """ status: TaskStatus """ - The task status. + Task status. """ href_from: str @@ -1536,7 +1563,7 @@ class Task: zone: Zone """ - The zone in which is the task. + Zone in which the task is excecuted. """ @@ -1552,7 +1579,14 @@ class UpdatePlacementGroupResponse: @dataclass class UpdatePlacementGroupServersResponse: + """ + Update placement group servers response. + """ + servers: List[PlacementGroupServer] + """ + Instances attached to the placement group. + """ @dataclass @@ -1573,12 +1607,12 @@ class Volume: id: str """ - The volume unique ID. + Volume unique ID. """ name: str """ - The volume name. + Volume name. """ export_uri: Optional[str] @@ -1589,52 +1623,52 @@ class Volume: size: int """ - The volume disk size. + Volume disk size. """ volume_type: VolumeVolumeType """ - The volume type. + Volume type. """ creation_date: Optional[datetime] """ - The volume creation date. + Volume creation date. """ modification_date: Optional[datetime] """ - The volume modification date. + Volume modification date. """ organization: str """ - The volume organization ID. + Volume Organization ID. """ project: str """ - The volume project ID. + Volume Project ID. """ tags: List[str] """ - The volume tags. + Volume tags. """ server: Optional[ServerSummary] """ - The server attached to the volume. + Instance attached to the volume. """ state: VolumeState """ - The volume state. + Volume state. """ zone: Zone """ - The zone in which is the volume. + Zone in which the volume is located. """ @@ -1680,7 +1714,7 @@ class VolumeServerTemplate: boot: bool """ - Force the server to boot on this volume. + Force the Instance to boot on this volume. """ name: str @@ -1700,7 +1734,7 @@ class VolumeServerTemplate: base_snapshot: str """ - The ID of the snapshot on which this volume will be based. + ID of the snapshot on which this volume will be based. """ organization: str @@ -1843,47 +1877,47 @@ class ListServersRequest: organization: Optional[str] """ - List only servers of this organization ID. + List only Instances of this Organization ID. """ project: Optional[str] """ - List only servers of this project ID. + List only Instances of this Project ID. """ name: Optional[str] """ - Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo"). + Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). """ private_ip: Optional[str] """ - List servers by private_ip. + List Instances by private_ip. """ without_ip: Optional[bool] """ - List servers that are not attached to a public IP. + List Instances that are not attached to a public IP. """ commercial_type: Optional[str] """ - List servers of this commercial type. + List Instances of this commercial type. """ state: Optional[ServerState] """ - List servers in this state. + List Instances in this state. """ tags: Optional[List[str]] """ - List servers with these exact tags (to filter with several tags, use commas to separate them). + List Instances with these exact tags (to filter with several tags, use commas to separate them). """ private_network: Optional[str] """ - List servers in this Private Network. + List Instances in this Private Network. """ order: Optional[ListServersRequestOrder] @@ -1911,7 +1945,7 @@ class GetServerRequest: server_id: str """ - UUID of the server you want to get. + UUID of the Instance you want to get. """ @@ -1934,18 +1968,18 @@ class ServerActionRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ action: ServerAction """ - The action to perform on the server. + Action to perform on the Instance. """ name: Optional[str] """ - The name of the backup you want to create. - The name of the backup you want to create. + Name of the backup you want to create. + Name of the backup you want to create. This field should only be specified when performing a backup action. """ @@ -1966,7 +2000,7 @@ class ListServerUserDataRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ @@ -1979,7 +2013,7 @@ class DeleteServerUserDataRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ key: str @@ -2075,7 +2109,7 @@ class CreateImageRequest: tags: Optional[List[str]] """ - The tags of the image. + Tags of the image. """ public: Optional[bool] @@ -2136,7 +2170,7 @@ class CreateSnapshotRequest: tags: Optional[List[str]] """ - The tags of the snapshot. + Tags of the snapshot. """ organization: Optional[str] @@ -2156,7 +2190,7 @@ class CreateSnapshotRequest: volume_type: SnapshotVolumeType """ - The volume type of the snapshot. + Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used. """ @@ -2212,7 +2246,7 @@ class ExportSnapshotRequest: snapshot_id: str """ - The snapshot ID. + Snapshot ID. """ bucket: str @@ -2250,12 +2284,12 @@ class ListVolumesRequest: organization: Optional[str] """ - Filter volume by organization ID. + Filter volume by Organization ID. """ project: Optional[str] """ - Filter volume by project ID. + Filter volume by Project ID. """ tags: Optional[List[str]] @@ -2278,12 +2312,12 @@ class CreateVolumeRequest: name: Optional[str] """ - The volume name. + Volume name. """ organization: Optional[str] """ - The volume organization ID. + Volume Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :deprecated @@ -2291,38 +2325,38 @@ class CreateVolumeRequest: project: Optional[str] """ - The volume project ID. + Volume Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. """ tags: Optional[List[str]] """ - The volume tags. + Volume tags. """ volume_type: VolumeVolumeType """ - The volume type. + Volume type. """ size: Optional[int] """ - The volume disk size, must be a multiple of 512. + Volume disk size, must be a multiple of 512. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. """ base_volume: Optional[str] """ - The ID of the volume on which this volume will be based. + ID of the volume on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. """ base_snapshot: Optional[str] """ - The ID of the snapshot on which this volume will be based. + ID of the snapshot on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. """ @@ -2355,17 +2389,17 @@ class UpdateVolumeRequest: name: Optional[str] """ - The volume name. + Volume name. """ tags: Optional[List[str]] """ - The tags of the volume. + Tags of the volume. """ size: Optional[int] """ - The volume disk size, must be a multiple of 512. + Volume disk size, must be a multiple of 512. """ @@ -2396,12 +2430,12 @@ class ListSecurityGroupsRequest: organization: Optional[str] """ - The security group organization ID. + Security group Organization ID. """ project: Optional[str] """ - The security group project ID. + Security group Project ID. """ tags: Optional[List[str]] @@ -2459,12 +2493,12 @@ class CreateSecurityGroupRequest: tags: Optional[List[str]] """ - The tags of the security group. + Tags of the security group. """ organization_default: Optional[bool] """ - Whether this security group becomes the default security group for new instances. + Defines whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. :deprecated @@ -2472,7 +2506,7 @@ class CreateSecurityGroupRequest: project_default: Optional[bool] """ - Whether this security group becomes the default security group for new instances. + Whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. """ @@ -2577,17 +2611,17 @@ class CreateSecurityGroupRuleRequest: dest_port_from: Optional[int] """ - The beginning of the range of ports to apply this rule to (inclusive). + Beginning of the range of ports to apply this rule to (inclusive). """ dest_port_to: Optional[int] """ - The end of the range of ports to apply this rule to (inclusive). + End of the range of ports to apply this rule to (inclusive). """ position: int """ - The position of this rule in the security group rules list. + Position of this rule in the security group rules list. """ editable: bool @@ -2657,12 +2691,12 @@ class ListPlacementGroupsRequest: organization: Optional[str] """ - List only placement groups of this organization ID. + List only placement groups of this Organization ID. """ project: Optional[str] """ - List only placement groups of this project ID. + List only placement groups of this Project ID. """ tags: Optional[List[str]] @@ -2705,17 +2739,17 @@ class CreatePlacementGroupRequest: tags: Optional[List[str]] """ - The tags of the placement group. + Tags of the placement group. """ policy_mode: PlacementGroupPolicyMode """ - The operating mode of the placement group. + Operating mode of the placement group. """ policy_type: PlacementGroupPolicyType """ - The policy type of the placement group. + Policy type of the placement group. """ @@ -2773,17 +2807,17 @@ class UpdatePlacementGroupRequest: tags: Optional[List[str]] """ - The tags of the placement group. + Tags of the placement group. """ policy_mode: Optional[PlacementGroupPolicyMode] """ - The operating mode of the placement group. + Operating mode of the placement group. """ policy_type: Optional[PlacementGroupPolicyType] """ - The policy type of the placement group. + Policy type of the placement group. """ @@ -2808,6 +2842,9 @@ class GetPlacementGroupServersRequest: """ placement_group_id: str + """ + UUID of the placement group you want to get. + """ @dataclass @@ -2818,8 +2855,14 @@ class SetPlacementGroupServersRequest: """ placement_group_id: str + """ + UUID of the placement group you want to set. + """ - servers: Optional[List[str]] + servers: List[str] + """ + An array of the Instances' UUIDs you want to configure. + """ @dataclass @@ -2831,10 +2874,13 @@ class UpdatePlacementGroupServersRequest: placement_group_id: str """ - UUID of the placement group. + UUID of the placement group you want to update. """ servers: List[str] + """ + An array of the Instances' UUIDs you want to configure. + """ @dataclass @@ -2846,12 +2892,12 @@ class ListIpsRequest: project: Optional[str] """ - The project ID the IPs are reserved in. + Project ID in which the IPs are reserved. """ organization: Optional[str] """ - The organization ID the IPs are reserved in. + Organization ID in which the IPs are reserved. """ tags: Optional[List[str]] @@ -2884,7 +2930,7 @@ class CreateIpRequest: organization: Optional[str] """ - The organization ID the IP is reserved in. + Organization ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :deprecated @@ -2892,19 +2938,19 @@ class CreateIpRequest: project: Optional[str] """ - The project ID the IP is reserved in. + Project ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. """ tags: Optional[List[str]] """ - The tags of the IP. + Tags of the IP. """ server: Optional[str] """ - UUID of the server you want to attach the IP to. + UUID of the Instance you want to attach the IP to. """ @@ -2917,7 +2963,7 @@ class GetIpRequest: ip: str """ - The IP ID or address to get. + IP ID or address to get. """ @@ -2955,7 +3001,7 @@ class DeleteIpRequest: ip: str """ - The ID or the address of the IP to delete. + ID or address of the IP to delete. """ @@ -2968,12 +3014,12 @@ class ListPrivateNICsRequest: server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ tags: Optional[List[str]] """ - The private NIC tags. + Private NIC tags. """ per_page: Optional[int] @@ -2996,7 +3042,7 @@ class CreatePrivateNICRequest: server_id: str """ - UUID of the server the private NIC will be attached to. + UUID of the Instance the private NIC will be attached to. """ private_network_id: str @@ -3006,7 +3052,7 @@ class CreatePrivateNICRequest: tags: Optional[List[str]] """ - The private NIC tags. + Private NIC tags. """ @@ -3019,12 +3065,12 @@ class GetPrivateNICRequest: server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ private_nic_id: str """ - The private NIC unique ID. + Private NIC unique ID. """ @@ -3037,12 +3083,12 @@ class UpdatePrivateNICRequest: server_id: str """ - UUID of the server the private NIC will be attached to. + UUID of the Instance the private NIC will be attached to. """ private_nic_id: str """ - The private NIC unique ID. + Private NIC unique ID. """ tags: Optional[List[str]] @@ -3060,12 +3106,12 @@ class DeletePrivateNICRequest: server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ private_nic_id: str """ - The private NIC unique ID. + Private NIC unique ID. """ diff --git a/scaleway-async/scaleway_async/instance/v1/types_private.py b/scaleway-async/scaleway_async/instance/v1/types_private.py index c135e4de0..5e9db72d1 100644 --- a/scaleway-async/scaleway_async/instance/v1/types_private.py +++ b/scaleway-async/scaleway_async/instance/v1/types_private.py @@ -97,27 +97,27 @@ class _CreateServerRequest: name: Optional[str] """ - The server name. + Instance name. """ dynamic_ip_required: Optional[bool] """ - Define if a dynamic IP is required for the instance. + Define if a dynamic IP is required for the Instance. """ commercial_type: str """ - Define the server commercial type (i.e. GP1-S). + Define the Instance commercial type (i.e. GP1-S). """ image: str """ - The server image ID or label. + Instance image ID or label. """ volumes: Optional[Dict[str, VolumeServerTemplate]] """ - The volumes attached to the server. + Volumes attached to the server. """ enable_ipv6: bool @@ -127,23 +127,23 @@ class _CreateServerRequest: public_ip: Optional[str] """ - The ID of the reserved IP to attach to the server. + ID of the reserved IP to attach to the server. """ boot_type: Optional[BootType] """ - The boot type to use. + Boot type to use. """ bootscript: Optional[str] """ - The bootscript ID to use when `boot_type` is set to `bootscript`. + Bootscript ID to use when `boot_type` is set to `bootscript`. :deprecated """ organization: Optional[str] """ - The server organization ID. + Instance Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :deprecated @@ -151,24 +151,24 @@ class _CreateServerRequest: project: Optional[str] """ - The server project ID. + Instance Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. """ tags: Optional[List[str]] """ - The server tags. + Instance tags. """ security_group: Optional[str] """ - The security group ID. + Security group ID. """ placement_group: Optional[str] """ - Placement group ID if server must be part of a placement group. + Placement group ID if Instance must be part of a placement group. """ @@ -181,42 +181,42 @@ class _SetServerRequest: id: str """ - The server unique ID. + Instance unique ID. """ name: str """ - The server name. + Instance name. """ organization: Optional[str] """ - The server organization ID. + Instance Organization ID. """ project: Optional[str] """ - The server project ID. + Instance Project ID. """ allowed_actions: Optional[List[ServerAction]] """ - Provide as list of allowed actions on the server. + Provide a list of allowed actions on the server. """ tags: Optional[List[str]] """ - The server associated tags. + Tags associated with the Instance. """ commercial_type: str """ - The server commercial type (eg. GP1-M). + Instance commercial type (eg. GP1-M). """ creation_date: Optional[datetime] """ - The server creation date. + Instance creation date. """ dynamic_ip_required: bool @@ -231,22 +231,22 @@ class _SetServerRequest: hostname: str """ - The server host name. + Instance host name. """ image: Optional[Image] """ - Provide information on the server image. + Provide information on the Instance image. """ protected: bool """ - The server protection option is activated. + Instance protection option is activated. """ private_ip: Optional[str] """ - The server private IP address. + Instance private IP address. """ public_ip: Optional[ServerIp] @@ -256,68 +256,68 @@ class _SetServerRequest: modification_date: Optional[datetime] """ - The server modification date. + Instance modification date. """ state: ServerState """ - The server state. + Instance state. """ location: Optional[ServerLocation] """ - The server location. + Instance location. """ ipv6: Optional[ServerIpv6] """ - The server IPv6 address. + Instance IPv6 address. """ bootscript: Optional[Bootscript] """ - The server bootscript. + Instance bootscript. :deprecated """ boot_type: BootType """ - The server boot type. + Instance boot type. """ volumes: Optional[Dict[str, Volume]] """ - The server volumes. + Instance volumes. """ security_group: Optional[SecurityGroupSummary] """ - The server security group. + Instance security group. """ maintenances: Optional[List[ServerMaintenance]] """ - The server planned maintenances. + Instance planned maintenances. """ state_detail: str """ - The server state_detail. + Instance state_detail. """ arch: Arch """ - The server arch. + Instance architecture (refers to the CPU architecture used for the Instance, e.g. x86_64, arm64). """ placement_group: Optional[PlacementGroup] """ - The server placement group. + Instance placement group. """ private_nics: Optional[List[PrivateNIC]] """ - The server private NICs. + Instance private NICs. """ @@ -330,19 +330,19 @@ class _UpdateServerRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ name: Optional[str] """ - Name of the server. + Name of the Instance. """ boot_type: Optional[BootType] tags: Optional[List[str]] """ - Tags of the server. + Tags of the Instance. """ volumes: Optional[Dict[str, VolumeServerTemplate]] @@ -362,12 +362,12 @@ class _UpdateServerRequest: placement_group: Optional[str] """ - Placement group ID if server must be part of a placement group. + Placement group ID if Instance must be part of a placement group. """ private_nics: Optional[List[PrivateNIC]] """ - The server private NICs. + Instance private NICs. """ @@ -451,32 +451,32 @@ class _SetSecurityGroupRequest: id: str """ - The ID of the security group (will be ignored). + ID of the security group (will be ignored). """ name: str """ - The name of the security group. + Name of the security group. """ tags: Optional[List[str]] """ - The tags of the security group. + Tags of the security group. """ creation_date: Optional[datetime] """ - The creation date of the security group (will be ignored). + Creation date of the security group (will be ignored). """ modification_date: Optional[datetime] """ - The modification date of the security group (will be ignored). + Modification date of the security group (will be ignored). """ description: str """ - The description of the security group. + Description of the security group. """ enable_default_security: bool @@ -486,22 +486,22 @@ class _SetSecurityGroupRequest: inbound_default_policy: SecurityGroupPolicy """ - The default inbound policy. + Default inbound policy. """ outbound_default_policy: SecurityGroupPolicy """ - The default outbound policy. + Default outbound policy. """ organization: Optional[str] """ - The security groups organization ID. + Security groups Organization ID. """ project: Optional[str] """ - The security group project ID. + Security group Project ID. """ organization_default: Optional[bool] @@ -512,12 +512,12 @@ class _SetSecurityGroupRequest: project_default: bool """ - True use this security group for future instances created in this project. + True use this security group for future Instances created in this project. """ servers: Optional[List[ServerSummary]] """ - The servers attached to this security group. + Instances attached to this security group. """ stateful: bool diff --git a/scaleway/scaleway/instance/v1/api.py b/scaleway/scaleway/instance/v1/api.py index 42407c567..435fc5d15 100644 --- a/scaleway/scaleway/instance/v1/api.py +++ b/scaleway/scaleway/instance/v1/api.py @@ -228,7 +228,7 @@ def get_server_types_availability( ) -> GetServerTypesAvailabilityResponse: """ Get availability. - Get availability for all server types. + Get availability for all Instance types. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: :param page: @@ -262,8 +262,8 @@ def list_servers_types( page: Optional[int] = None, ) -> ListServersTypesResponse: """ - List server types. - Get server types technical details. + List Instance types. + List available Instance types and their technical details. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: :param page: @@ -298,7 +298,7 @@ def list_volumes_types( ) -> ListVolumesTypesResponse: """ List volumes types. - Get volumes technical details. + List all volume types and their technical details. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: :param page: @@ -342,19 +342,20 @@ def list_servers( order: ListServersRequestOrder = ListServersRequestOrder.CREATION_DATE_DESC, ) -> ListServersResponse: """ - List all servers. + List all Instances. + List all Instances in a specified Availability Zone, e.g. `fr-par-1`. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only servers of this organization ID. - :param project: List only servers of this project ID. - :param name: Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo"). - :param private_ip: List servers by private_ip. - :param without_ip: List servers that are not attached to a public IP. - :param commercial_type: List servers of this commercial type. - :param state: List servers in this state. - :param tags: List servers with these exact tags (to filter with several tags, use commas to separate them). - :param private_network: List servers in this Private Network. + :param organization: List only Instances of this Organization ID. + :param project: List only Instances of this Project ID. + :param name: Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). + :param private_ip: List Instances by private_ip. + :param without_ip: List Instances that are not attached to a public IP. + :param commercial_type: List Instances of this commercial type. + :param state: List Instances in this state. + :param tags: List Instances with these exact tags (to filter with several tags, use commas to separate them). + :param private_network: List Instances in this Private Network. :param order: Define the order of the returned servers. :return: :class:`ListServersResponse ` @@ -406,19 +407,20 @@ def list_servers_all( order: Optional[ListServersRequestOrder] = None, ) -> List[Server]: """ - List all servers. + List all Instances. + List all Instances in a specified Availability Zone, e.g. `fr-par-1`. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only servers of this organization ID. - :param project: List only servers of this project ID. - :param name: Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo"). - :param private_ip: List servers by private_ip. - :param without_ip: List servers that are not attached to a public IP. - :param commercial_type: List servers of this commercial type. - :param state: List servers in this state. - :param tags: List servers with these exact tags (to filter with several tags, use commas to separate them). - :param private_network: List servers in this Private Network. + :param organization: List only Instances of this Organization ID. + :param project: List only Instances of this Project ID. + :param name: Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). + :param private_ip: List Instances by private_ip. + :param without_ip: List Instances that are not attached to a public IP. + :param commercial_type: List Instances of this commercial type. + :param state: List Instances in this state. + :param tags: List Instances with these exact tags (to filter with several tags, use commas to separate them). + :param private_network: List Instances in this Private Network. :param order: Define the order of the returned servers. :return: :class:`List[ListServersResponse] ` @@ -469,44 +471,28 @@ def _create_server( placement_group: Optional[str] = None, ) -> CreateServerResponse: """ - Create a server. - The `volumes` key is a dictionary composed of the volume position as key and the volume parameters as value. - Depending of the volume parameters, you can achieve different behaviours : - - Create a volume from a snapshot of an image : - Optional : `volume_type`, `size`, `boot`. - If the `size` parameter is not set, the size of the volume will equal the size of the corresponding snapshot of the image. - - Attach an existing volume : - Required : `id`, `name`. - Optional : `boot`. - - Create an empty volume : - Required : `name`, `volume_type`, `size`. - Optional : `organization`, `project`, `boot`. - - Create a volume from a snapshot : - Required : `base_snapshot`, `name`, `volume_type`. - Optional : `organization`, `project`, `boot`. + Create an Instance. + Create a new Instance of the specified commercial type in the specified zone. Pay attention to the volumes parameter, which takes an object which can be used in different ways to achieve different behaviors. + Get more information in the [Technical Information](#technical-information) section of the introduction. :param zone: Zone to target. If none is passed will use default zone from the config. - :param name: The server name. - :param dynamic_ip_required: Define if a dynamic IP is required for the instance. - :param commercial_type: Define the server commercial type (i.e. GP1-S). - :param image: The server image ID or label. - :param volumes: The volumes attached to the server. + :param name: Instance name. + :param dynamic_ip_required: Define if a dynamic IP is required for the Instance. + :param commercial_type: Define the Instance commercial type (i.e. GP1-S). + :param image: Instance image ID or label. + :param volumes: Volumes attached to the server. :param enable_ipv6: True if IPv6 is enabled on the server. - :param public_ip: The ID of the reserved IP to attach to the server. - :param boot_type: The boot type to use. - :param bootscript: The bootscript ID to use when `boot_type` is set to `bootscript`. - :param organization: The server organization ID. + :param public_ip: ID of the reserved IP to attach to the server. + :param boot_type: Boot type to use. + :param bootscript: Bootscript ID to use when `boot_type` is set to `bootscript`. + :param organization: Instance Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param project: The server project ID. + :param project: Instance Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The server tags. - :param security_group: The security group ID. - :param placement_group: Placement group ID if server must be part of a placement group. + :param tags: Instance tags. + :param security_group: Security group ID. + :param placement_group: Placement group ID if Instance must be part of a placement group. :return: :class:`CreateServerResponse ` Usage: @@ -556,8 +542,8 @@ def delete_server( zone: Optional[Zone] = None, ) -> Optional[None]: """ - Delete a server. - Delete a server with the given ID. + Delete an Instance. + Delete the Instance with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param server_id: @@ -585,10 +571,10 @@ def get_server( zone: Optional[Zone] = None, ) -> GetServerResponse: """ - Get a server. - Get the details of a specified Server. + Get an Instance. + Get the details of a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server you want to get. + :param server_id: UUID of the Instance you want to get. :return: :class:`GetServerResponse ` Usage: @@ -724,20 +710,21 @@ def _update_server( private_nics: Optional[List[PrivateNIC]] = None, ) -> UpdateServerResponse: """ - Update a server. + Update an Instance. + Update the Instance information, such as name, boot mode, or tags. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. - :param name: Name of the server. + :param server_id: UUID of the Instance. + :param name: Name of the Instance. :param boot_type: - :param tags: Tags of the server. + :param tags: Tags of the Instance. :param volumes: :param bootscript: :param dynamic_ip_required: :param enable_ipv6: :param protected: :param security_group: - :param placement_group: Placement group ID if server must be part of a placement group. - :param private_nics: The server private NICs. + :param placement_group: Placement group ID if Instance must be part of a placement group. + :param private_nics: Instance private NICs. :return: :class:`UpdateServerResponse ` Usage: @@ -782,8 +769,8 @@ def list_server_actions( zone: Optional[Zone] = None, ) -> ListServerActionsResponse: """ - List server actions. - List all actions that can currently be performed on a server. + List Instance actions. + List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance. :param zone: Zone to target. If none is passed will use default zone from the config. :param server_id: :return: :class:`ListServerActionsResponse ` @@ -816,12 +803,23 @@ def server_action( ) -> ServerActionResponse: """ Perform action. - Perform power related actions on a server. Be wary that when terminating a server, all the attached volumes (local *and* block storage) are deleted. So, if you want to keep your local volumes, you must use the `archive` action instead of `terminate`. And if you want to keep block-storage volumes, **you must** detach it beforehand you issue the `terminate` call. For more information, read the [Volumes](#volumes-7e8a39) documentation. - :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. - :param action: The action to perform on the server. - :param name: The name of the backup you want to create. - The name of the backup you want to create. + Perform an action on an Instance. + Available actions are: + * `poweron`: Start a stopped Instance. + * `poweroff`: Fully stop the Instance and release the hypervisor slot. + * `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor. + * `reboot`: Stop the instance and restart it. + * `backup`: Create an image with all the volumes of an Instance. + * `terminate`: Delete the Instance along with all attached volumes. + + Keep in mind that terminating an Instance will result in the deletion of all attached volumes, including local and block storage. + If you want to preserve your local volumes, you should use the `archive` action instead of `terminate`. Similarly, if you want to keep your block storage volumes, you must first detach them before issuing the `terminate` command. + For more information, read the [Volumes](#volumes-7e8a39) documentation. + :param zone: Zone to target. If none is passed will use default zone from the config. + :param server_id: UUID of the Instance. + :param action: Action to perform on the Instance. + :param name: Name of the backup you want to create. + Name of the backup you want to create. This field should only be specified when performing a backup action. :param volumes: For each volume UUID, the snapshot parameters of the volume. For each volume UUID, the snapshot parameters of the volume. @@ -866,9 +864,9 @@ def list_server_user_data( ) -> ListServerUserDataResponse: """ List user data. - List all user data keys registered on a given server. + List all user data keys registered on a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. + :param server_id: UUID of the Instance. :return: :class:`ListServerUserDataResponse ` Usage: @@ -897,9 +895,9 @@ def delete_server_user_data( ) -> Optional[None]: """ Delete user data. - Delete the given key from a server user data. + Delete the specified key from an Instance's user data. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server. + :param server_id: UUID of the Instance. :param key: Key of the user data to delete. Usage: @@ -937,8 +935,8 @@ def list_images( tags: Optional[str] = None, ) -> ListImagesResponse: """ - List instance images. - List all images available in an account. + List Instance images. + List all existing Instance images. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -990,8 +988,8 @@ def list_images_all( tags: Optional[str] = None, ) -> List[Image]: """ - List instance images. - List all images available in an account. + List Instance images. + List all existing Instance images. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -1033,8 +1031,8 @@ def get_image( zone: Optional[Zone] = None, ) -> GetImageResponse: """ - Get an instance image. - Get details of an image with the given ID. + Get an Instance image. + Get details of an image with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param image_id: UUID of the image you want to get. :return: :class:`GetImageResponse ` @@ -1071,7 +1069,8 @@ def create_image( public: Optional[bool] = None, ) -> CreateImageResponse: """ - Create an instance image. + Create an Instance image. + Create an Instance image from the specified snapshot ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the image. :param root_volume: UUID of the snapshot. @@ -1084,7 +1083,7 @@ def create_image( :param project: Project ID of the image. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the image. + :param tags: Tags of the image. :param public: True to create a public image. :return: :class:`CreateImageResponse ` @@ -1209,8 +1208,8 @@ def delete_image( zone: Optional[Zone] = None, ) -> Optional[None]: """ - Delete an instance image. - Delete the image with the given ID. + Delete an Instance image. + Delete the image with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param image_id: UUID of the image you want to delete. @@ -1244,6 +1243,7 @@ def list_snapshots( ) -> ListSnapshotsResponse: """ List snapshots. + List all snapshots of an Organization in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -1290,6 +1290,7 @@ def list_snapshots_all( ) -> List[Snapshot]: """ List snapshots. + List all snapshots of an Organization in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param organization: :param per_page: @@ -1335,18 +1336,19 @@ def create_snapshot( size: Optional[int] = None, ) -> CreateSnapshotResponse: """ - Create a snapshot from a given volume or from a QCOW2 file. + Create a snapshot from a specified volume or from a QCOW2 file. + Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the snapshot. :param volume_id: UUID of the volume. - :param tags: The tags of the snapshot. + :param tags: Tags of the snapshot. :param organization: Organization ID of the snapshot. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :param project: Project ID of the snapshot. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param volume_type: The volume type of the snapshot. + :param volume_type: Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used. :param bucket: Bucket name for snapshot imports. @@ -1393,7 +1395,7 @@ def get_snapshot( ) -> GetSnapshotResponse: """ Get a snapshot. - Get details of a snapshot with the given ID. + Get details of a snapshot with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param snapshot_id: UUID of the snapshot you want to get. :return: :class:`GetSnapshotResponse ` @@ -1500,7 +1502,7 @@ def delete_snapshot( ) -> Optional[None]: """ Delete a snapshot. - Delete the snapshot with the given ID. + Delete the snapshot with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param snapshot_id: UUID of the snapshot you want to delete. @@ -1531,9 +1533,9 @@ def export_snapshot( ) -> ExportSnapshotResponse: """ Export a snapshot. - Export a snapshot to a given S3 bucket in the same region. + Export a snapshot to a specified S3 bucket in the same region. :param zone: Zone to target. If none is passed will use default zone from the config. - :param snapshot_id: The snapshot ID. + :param snapshot_id: Snapshot ID. :param bucket: S3 bucket name. :param key: S3 object key. :return: :class:`ExportSnapshotResponse ` @@ -1582,12 +1584,13 @@ def list_volumes( ) -> ListVolumesResponse: """ List volumes. + List volumes in the specified Availability Zone. You can filter the output by volume type. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_type: Filter by volume type. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: Filter volume by organization ID. - :param project: Filter volume by project ID. + :param organization: Filter volume by Organization ID. + :param project: Filter volume by Project ID. :param tags: Filter volumes with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter volume by name (for eg. "vol" will return "myvolume" but not "data"). :return: :class:`ListVolumesResponse ` @@ -1631,12 +1634,13 @@ def list_volumes_all( ) -> List[Volume]: """ List volumes. + List volumes in the specified Availability Zone. You can filter the output by volume type. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_type: Filter by volume type. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: Filter volume by organization ID. - :param project: Filter volume by project ID. + :param organization: Filter volume by Organization ID. + :param project: Filter volume by Project ID. :param tags: Filter volumes with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter volume by name (for eg. "vol" will return "myvolume" but not "data"). :return: :class:`List[ListVolumesResponse] ` @@ -1678,23 +1682,24 @@ def create_volume( ) -> CreateVolumeResponse: """ Create a volume. + Create a volume of a specified type in an Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. - :param name: The volume name. - :param organization: The volume organization ID. + :param name: Volume name. + :param organization: Volume Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param project: The volume project ID. + :param project: Volume Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The volume tags. - :param volume_type: The volume type. - :param size: The volume disk size, must be a multiple of 512. + :param tags: Volume tags. + :param volume_type: Volume type. + :param size: Volume disk size, must be a multiple of 512. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. - :param base_volume: The ID of the volume on which this volume will be based. + :param base_volume: ID of the volume on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. - :param base_snapshot: The ID of the snapshot on which this volume will be based. + :param base_snapshot: ID of the snapshot on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. :return: :class:`CreateVolumeResponse ` @@ -1737,7 +1742,7 @@ def get_volume( ) -> GetVolumeResponse: """ Get a volume. - Get details of a volume with the given ID. + Get details of a volume with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_id: UUID of the volume you want to get. :return: :class:`GetVolumeResponse ` @@ -1770,12 +1775,12 @@ def update_volume( ) -> UpdateVolumeResponse: """ Update a volume. - Replace name and/or size properties of given ID volume with the given value(s). Any volume name can be changed while, for now, only `b_ssd` volume growing is supported. + Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_id: UUID of the volume. - :param name: The volume name. - :param tags: The tags of the volume. - :param size: The volume disk size, must be a multiple of 512. + :param name: Volume name. + :param tags: Tags of the volume. + :param size: Volume disk size, must be a multiple of 512. :return: :class:`UpdateVolumeResponse ` Usage: @@ -1813,7 +1818,7 @@ def delete_volume( ) -> Optional[None]: """ Delete a volume. - Delete the volume with the given ID. + Delete the volume with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param volume_id: UUID of the volume you want to delete. @@ -1848,11 +1853,11 @@ def list_security_groups( ) -> ListSecurityGroupsResponse: """ List security groups. - List all security groups available in an account. + List all existing security groups. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the security group. - :param organization: The security group organization ID. - :param project: The security group project ID. + :param organization: Security group Organization ID. + :param project: Security group Project ID. :param tags: List security groups with these exact tags (to filter with several tags, use commas to separate them). :param project_default: Filter security groups with this value for project_default. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -1898,11 +1903,11 @@ def list_security_groups_all( ) -> List[SecurityGroup]: """ List security groups. - List all security groups available in an account. + List all existing security groups. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the security group. - :param organization: The security group organization ID. - :param project: The security group project ID. + :param organization: Security group Organization ID. + :param project: Security group Project ID. :param tags: List security groups with these exact tags (to filter with several tags, use commas to separate them). :param project_default: Filter security groups with this value for project_default. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -1949,6 +1954,7 @@ def create_security_group( ) -> CreateSecurityGroupResponse: """ Create a security group. + Create a security group with a specified name and description. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the security group. :param description: Description of the security group. @@ -1958,11 +1964,11 @@ def create_security_group( :param project: Project ID the security group belong to. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the security group. - :param organization_default: Whether this security group becomes the default security group for new instances. + :param tags: Tags of the security group. + :param organization_default: Defines whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. - :param project_default: Whether this security group becomes the default security group for new instances. + :param project_default: Whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. :param stateful: Whether the security group is stateful or not. @@ -2017,7 +2023,7 @@ def get_security_group( ) -> GetSecurityGroupResponse: """ Get a security group. - Get the details of a Security Group with the given ID. + Get the details of a security group with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group you want to get. :return: :class:`GetSecurityGroupResponse ` @@ -2049,6 +2055,7 @@ def delete_security_group( ) -> Optional[None]: """ Delete a security group. + Delete a security group with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group you want to delete. @@ -2095,20 +2102,20 @@ def _set_security_group( Update a security group. Replace all security group properties with a security group message. :param zone: Zone to target. If none is passed will use default zone from the config. - :param id: The ID of the security group (will be ignored). - :param name: The name of the security group. - :param tags: The tags of the security group. - :param creation_date: The creation date of the security group (will be ignored). - :param modification_date: The modification date of the security group (will be ignored). - :param description: The description of the security group. + :param id: ID of the security group (will be ignored). + :param name: Name of the security group. + :param tags: Tags of the security group. + :param creation_date: Creation date of the security group (will be ignored). + :param modification_date: Modification date of the security group (will be ignored). + :param description: Description of the security group. :param enable_default_security: True to block SMTP on IPv4 and IPv6. - :param inbound_default_policy: The default inbound policy. - :param outbound_default_policy: The default outbound policy. - :param organization: The security groups organization ID. - :param project: The security group project ID. + :param inbound_default_policy: Default inbound policy. + :param outbound_default_policy: Default outbound policy. + :param organization: Security groups Organization ID. + :param project: Security group Project ID. :param organization_default: Please use project_default instead. - :param project_default: True use this security group for future instances created in this project. - :param servers: The servers attached to this security group. + :param project_default: True use this security group for future Instances created in this project. + :param servers: Instances attached to this security group. :param stateful: True to set the security group as stateful. :return: :class:`_SetSecurityGroupResponse <_SetSecurityGroupResponse>` @@ -2196,6 +2203,7 @@ def list_security_group_rules( ) -> ListSecurityGroupRulesResponse: """ List rules. + List the rules of the a specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -2235,6 +2243,7 @@ def list_security_group_rules_all( ) -> List[SecurityGroupRule]: """ List rules. + List the rules of the a specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -2275,15 +2284,16 @@ def create_security_group_rule( ) -> CreateSecurityGroupRuleResponse: """ Create rule. + Create a rule in the specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group. :param protocol: :param direction: :param action: :param ip_range: - :param dest_port_from: The beginning of the range of ports to apply this rule to (inclusive). - :param dest_port_to: The end of the range of ports to apply this rule to (inclusive). - :param position: The position of this rule in the security group rules list. + :param dest_port_from: Beginning of the range of ports to apply this rule to (inclusive). + :param dest_port_to: End of the range of ports to apply this rule to (inclusive). + :param position: Position of this rule in the security group rules list. :param editable: Indicates if this rule is editable (will be ignored). :return: :class:`CreateSecurityGroupRuleResponse ` @@ -2335,7 +2345,7 @@ def set_security_group_rules( ) -> SetSecurityGroupRulesResponse: """ Update all the rules of a security group. - Replaces the rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request. + Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: UUID of the security group to update the rules on. :param rules: List of rules to update in the security group. @@ -2377,7 +2387,7 @@ def delete_security_group_rule( ) -> Optional[None]: """ Delete rule. - Delete a security group rule with the given ID. + Delete a security group rule with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: :param security_group_rule_id: @@ -2416,7 +2426,7 @@ def get_security_group_rule( ) -> GetSecurityGroupRuleResponse: """ Get rule. - Get details of a security group rule with the given ID. + Get details of a security group rule with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: :param security_group_rule_id: @@ -2465,6 +2475,7 @@ def _set_security_group_rule( ) -> _SetSecurityGroupRuleResponse: """ Update security group rule. + Update the rule of a specified security group ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param security_group_id: :param security_group_rule_id: @@ -2541,12 +2552,12 @@ def list_placement_groups( ) -> ListPlacementGroupsResponse: """ List placement groups. - List all placement groups. + List all placement groups in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only placement groups of this organization ID. - :param project: List only placement groups of this project ID. + :param organization: List only placement groups of this Organization ID. + :param project: List only placement groups of this Project ID. :param tags: List placement groups with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo"). :return: :class:`ListPlacementGroupsResponse ` @@ -2588,12 +2599,12 @@ def list_placement_groups_all( ) -> List[PlacementGroup]: """ List placement groups. - List all placement groups. + List all placement groups in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. - :param organization: List only placement groups of this organization ID. - :param project: List only placement groups of this project ID. + :param organization: List only placement groups of this Organization ID. + :param project: List only placement groups of this Project ID. :param tags: List placement groups with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo"). :return: :class:`List[ListPlacementGroupsResponse] ` @@ -2632,7 +2643,7 @@ def create_placement_group( ) -> CreatePlacementGroupResponse: """ Create a placement group. - Create a new placement group. + Create a new placement group in a specified Availability Zone. :param zone: Zone to target. If none is passed will use default zone from the config. :param name: Name of the placement group. :param organization: Organization ID of the placement group. @@ -2641,9 +2652,9 @@ def create_placement_group( :param project: Project ID of the placement group. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the placement group. - :param policy_mode: The operating mode of the placement group. - :param policy_type: The policy type of the placement group. + :param tags: Tags of the placement group. + :param policy_mode: Operating mode of the placement group. + :param policy_type: Policy type of the placement group. :return: :class:`CreatePlacementGroupResponse ` Usage: @@ -2685,7 +2696,7 @@ def get_placement_group( ) -> GetPlacementGroupResponse: """ Get a placement group. - Get the given placement group. + Get the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: UUID of the placement group you want to get. :return: :class:`GetPlacementGroupResponse ` @@ -2723,7 +2734,7 @@ def set_placement_group( ) -> SetPlacementGroupResponse: """ Set placement group. - Set all parameters of the given placement group. + Set all parameters of the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: :param name: @@ -2783,13 +2794,13 @@ def update_placement_group( ) -> UpdatePlacementGroupResponse: """ Update a placement group. - Update one or more parameter of the given placement group. + Update one or more parameter of the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: UUID of the placement group. :param name: Name of the placement group. - :param tags: The tags of the placement group. - :param policy_mode: The operating mode of the placement group. - :param policy_type: The policy type of the placement group. + :param tags: Tags of the placement group. + :param policy_mode: Operating mode of the placement group. + :param policy_type: Policy type of the placement group. :return: :class:`UpdatePlacementGroupResponse ` Usage: @@ -2829,7 +2840,7 @@ def delete_placement_group( zone: Optional[Zone] = None, ) -> Optional[None]: """ - Delete the given placement group. + Delete the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. :param placement_group_id: UUID of the placement group you want to delete. @@ -2860,9 +2871,9 @@ def get_placement_group_servers( ) -> GetPlacementGroupServersResponse: """ Get placement group servers. - Get all servers belonging to the given placement group. + Get all Instances belonging to the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. - :param placement_group_id: + :param placement_group_id: UUID of the placement group you want to get. :return: :class:`GetPlacementGroupServersResponse ` Usage: @@ -2888,21 +2899,24 @@ def set_placement_group_servers( self, *, placement_group_id: str, + servers: List[str], zone: Optional[Zone] = None, - servers: Optional[List[str]] = None, ) -> SetPlacementGroupServersResponse: """ Set placement group servers. - Set all servers belonging to the given placement group. + Set all Instances belonging to the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. - :param placement_group_id: - :param servers: + :param placement_group_id: UUID of the placement group you want to set. + :param servers: An array of the Instances' UUIDs you want to configure. :return: :class:`SetPlacementGroupServersResponse ` Usage: :: - result = api.set_placement_group_servers(placement_group_id="example") + result = api.set_placement_group_servers( + placement_group_id="example", + servers=["example"], + ) """ param_zone = validate_path_param("zone", zone or self.client.default_zone) @@ -2916,8 +2930,8 @@ def set_placement_group_servers( body=marshal_SetPlacementGroupServersRequest( SetPlacementGroupServersRequest( placement_group_id=placement_group_id, - zone=zone, servers=servers, + zone=zone, ), self.client, ), @@ -2935,10 +2949,10 @@ def update_placement_group_servers( ) -> UpdatePlacementGroupServersResponse: """ Update placement group servers. - Update all servers belonging to the given placement group. + Update all Instances belonging to the specified placement group. :param zone: Zone to target. If none is passed will use default zone from the config. - :param placement_group_id: UUID of the placement group. - :param servers: + :param placement_group_id: UUID of the placement group you want to update. + :param servers: An array of the Instances' UUIDs you want to configure. :return: :class:`UpdatePlacementGroupServersResponse ` Usage: @@ -2984,9 +2998,10 @@ def list_ips( ) -> ListIpsResponse: """ List all flexible IPs. + List all flexible IPs in a specified zone. :param zone: Zone to target. If none is passed will use default zone from the config. - :param project: The project ID the IPs are reserved in. - :param organization: The organization ID the IPs are reserved in. + :param project: Project ID in which the IPs are reserved. + :param organization: Organization ID in which the IPs are reserved. :param tags: Filter IPs with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter on the IP address (Works as a LIKE operation on the IP address). :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -3030,9 +3045,10 @@ def list_ips_all( ) -> List[Ip]: """ List all flexible IPs. + List all flexible IPs in a specified zone. :param zone: Zone to target. If none is passed will use default zone from the config. - :param project: The project ID the IPs are reserved in. - :param organization: The organization ID the IPs are reserved in. + :param project: Project ID in which the IPs are reserved. + :param organization: Organization ID in which the IPs are reserved. :param tags: Filter IPs with these exact tags (to filter with several tags, use commas to separate them). :param name: Filter on the IP address (Works as a LIKE operation on the IP address). :param per_page: A positive integer lower or equal to 100 to select the number of items to return. @@ -3071,15 +3087,16 @@ def create_ip( ) -> CreateIpResponse: """ Reserve a flexible IP. + Reserve a flexible IP and attach it to the specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param organization: The organization ID the IP is reserved in. + :param organization: Organization ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param project: The project ID the IP is reserved in. + :param project: Project ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. - :param tags: The tags of the IP. - :param server: UUID of the server you want to attach the IP to. + :param tags: Tags of the IP. + :param server: UUID of the Instance you want to attach the IP to. :return: :class:`CreateIpResponse ` Usage: @@ -3116,9 +3133,9 @@ def get_ip( ) -> GetIpResponse: """ Get a flexible IP. - Get details of an IP with the given ID or address. + Get details of an IP with the specified ID or address. :param zone: Zone to target. If none is passed will use default zone from the config. - :param ip: The IP ID or address to get. + :param ip: IP ID or address to get. :return: :class:`GetIpResponse ` Usage: @@ -3149,6 +3166,7 @@ def update_ip( ) -> UpdateIpResponse: """ Update a flexible IP. + Update a flexible IP in the specified zone with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param ip: IP ID or IP address. :param reverse: Reverse domain name. @@ -3191,9 +3209,9 @@ def delete_ip( ) -> Optional[None]: """ Delete a flexible IP. - Delete the IP with the given ID. + Delete the IP with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. - :param ip: The ID or the address of the IP to delete. + :param ip: ID or address of the IP to delete. Usage: :: @@ -3223,10 +3241,10 @@ def list_private_ni_cs( ) -> ListPrivateNICsResponse: """ List all private NICs. - List all private NICs of a given server. + List all private NICs of a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param tags: The private NIC tags. + :param server_id: Instance to which the private NIC is attached. + :param tags: Private NIC tags. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. :return: :class:`ListPrivateNICsResponse ` @@ -3264,10 +3282,10 @@ def list_private_ni_cs_all( ) -> List[PrivateNIC]: """ List all private NICs. - List all private NICs of a given server. + List all private NICs of a specified Instance. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param tags: The private NIC tags. + :param server_id: Instance to which the private NIC is attached. + :param tags: Private NIC tags. :param per_page: A positive integer lower or equal to 100 to select the number of items to return. :param page: A positive integer to choose the page to return. :return: :class:`List[ListPrivateNICsResponse] ` @@ -3300,11 +3318,11 @@ def create_private_nic( tags: Optional[List[str]] = None, ) -> CreatePrivateNICResponse: """ - Create a private NIC connecting a server to a private network. + Create a private NIC connecting an Instance to a Private Network. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server the private NIC will be attached to. + :param server_id: UUID of the Instance the private NIC will be attached to. :param private_network_id: UUID of the private network where the private NIC will be attached. - :param tags: The private NIC tags. + :param tags: Private NIC tags. :return: :class:`CreatePrivateNICResponse ` Usage: @@ -3347,8 +3365,8 @@ def get_private_nic( Get a private NIC. Get private NIC properties. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param private_nic_id: The private NIC unique ID. + :param server_id: Instance to which the private NIC is attached. + :param private_nic_id: Private NIC unique ID. :return: :class:`GetPrivateNICResponse ` Usage: @@ -3382,10 +3400,10 @@ def update_private_nic( ) -> PrivateNIC: """ Update a private NIC. - Update one or more parameter/s to a given private NIC. + Update one or more parameter(s) of a specified private NIC. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: UUID of the server the private NIC will be attached to. - :param private_nic_id: The private NIC unique ID. + :param server_id: UUID of the Instance the private NIC will be attached to. + :param private_nic_id: Private NIC unique ID. :param tags: Tags used to select private NIC/s. :return: :class:`PrivateNIC ` @@ -3429,8 +3447,8 @@ def delete_private_nic( """ Delete a private NIC. :param zone: Zone to target. If none is passed will use default zone from the config. - :param server_id: The server the private NIC is attached to. - :param private_nic_id: The private NIC unique ID. + :param server_id: Instance to which the private NIC is attached. + :param private_nic_id: Private NIC unique ID. Usage: :: @@ -3552,7 +3570,7 @@ def get_bootscript( ) -> GetBootscriptResponse: """ Get bootscripts. - Get details of a bootscript with the given ID. + Get details of a bootscript with the specified ID. :param zone: Zone to target. If none is passed will use default zone from the config. :param bootscript_id: :return: :class:`GetBootscriptResponse ` diff --git a/scaleway/scaleway/instance/v1/types.py b/scaleway/scaleway/instance/v1/types.py index e4a42b41b..ff7422e20 100644 --- a/scaleway/scaleway/instance/v1/types.py +++ b/scaleway/scaleway/instance/v1/types.py @@ -233,42 +233,42 @@ class Bootscript: bootcmdargs: str """ - The bootscript arguments. + Bootscript arguments. """ default: bool """ - Dispmay if the bootscript is the default bootscript if no other boot option is configured. + Display if the bootscript is the default bootscript (if no other boot option is configured). """ dtb: str """ - Provide information regarding a Device Tree Binary (dtb) for use with C1 servers. + Provide information regarding a Device Tree Binary (DTB) for use with C1 servers. """ id: str """ - The bootscript ID. + Bootscript ID. """ initrd: str """ - The initrd (initial ramdisk) configuration. + Initrd (initial ramdisk) configuration. """ kernel: str """ - The server kernel version. + Instance kernel version. """ organization: str """ - The bootscript organization ID. + Bootscript Organization ID. """ project: str """ - The bootscript project ID. + Bootscript Project ID. """ public: bool @@ -278,17 +278,17 @@ class Bootscript: title: str """ - The bootscript title. + Bootscript title. """ arch: Arch """ - The bootscript arch. + Bootscript architecture. """ zone: Zone """ - The zone in which is the bootscript. + Zone in which the bootscript is located. """ @@ -404,7 +404,14 @@ class GetPlacementGroupResponse: @dataclass class GetPlacementGroupServersResponse: + """ + Get placement group servers response. + """ + servers: List[PlacementGroupServer] + """ + Instances attached to the placement group. + """ @dataclass @@ -629,12 +636,12 @@ class ListServersResponse: total_count: int """ - Total number of servers. + Total number of Instances. """ servers: List[Server] """ - List of servers. + List of Instances. """ @@ -646,12 +653,12 @@ class ListServersTypesResponse: total_count: int """ - Total number of server types. + Total number of Instance types. """ servers: Dict[str, ServerType] """ - List of server types. + List of Instance types. """ @@ -714,32 +721,32 @@ class PlacementGroup: id: str """ - The placement group unique ID. + Placement group unique ID. """ name: str """ - The placement group name. + Placement group name. """ organization: str """ - The placement group organization ID. + Placement group Organization ID. """ project: str """ - The placement group project ID. + Placement group Project ID. """ tags: List[str] """ - The placement group tags. + Placement group tags. """ policy_mode: PlacementGroupPolicyMode """ - Select the failling mode when the placement cannot be respected, either optional or enforced. + Select the failure mode when the placement cannot be respected, either optional or enforced. """ policy_type: PlacementGroupPolicyType @@ -754,17 +761,30 @@ class PlacementGroup: zone: Zone """ - The zone in which is the placement group. + Zone in which the placement group is located. """ @dataclass class PlacementGroupServer: + """ + Placement group server. + """ + id: str + """ + Instance UUID. + """ name: str + """ + Instance name. + """ policy_respected: bool + """ + Defines whether the placement group policy is respected (either 1 or 0). + """ @dataclass @@ -775,32 +795,32 @@ class PrivateNIC: id: str """ - The private NIC unique ID. + Private NIC unique ID. """ server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ private_network_id: str """ - The private network where the private NIC is attached. + Private Network the private NIC is attached to. """ mac_address: str """ - The private NIC MAC address. + Private NIC MAC address. """ state: PrivateNICState """ - The private NIC state. + Private NIC state. """ tags: List[str] """ - The private NIC tags. + Private NIC tags. """ @@ -812,17 +832,17 @@ class SecurityGroup: id: str """ - The security groups' unique ID. + Security group unique ID. """ name: str """ - The security groups name. + Security group name. """ description: str """ - The security groups description. + Security group description. """ enable_default_security: bool @@ -832,58 +852,58 @@ class SecurityGroup: inbound_default_policy: SecurityGroupPolicy """ - The default inbound policy. + Default inbound policy. """ outbound_default_policy: SecurityGroupPolicy """ - The default outbound policy. + Default outbound policy. """ organization: str """ - The security groups organization ID. + Security group Organization ID. """ project: str """ - The security group project ID. + Security group Project ID. """ tags: List[str] """ - The security group tags. + Security group tags. """ organization_default: Optional[bool] """ - True if it is your default security group for this organization ID. + True if it is your default security group for this Organization ID. :deprecated """ project_default: bool """ - True if it is your default security group for this project ID. + True if it is your default security group for this Project ID. """ creation_date: Optional[datetime] """ - The security group creation date. + Security group creation date. """ modification_date: Optional[datetime] """ - The security group modification date. + Security group modification date. """ servers: List[ServerSummary] """ - List of servers attached to this security group. + List of Instances attached to this security group. """ stateful: bool """ - True if the security group is stateful. + Defines whether the security group is stateful. """ state: SecurityGroupState @@ -893,7 +913,7 @@ class SecurityGroup: zone: Zone """ - The zone in which is the security group. + Zone in which the security group is located. """ @@ -942,42 +962,42 @@ class Server: id: str """ - The server unique ID. + Instance unique ID. """ name: str """ - The server name. + Instance name. """ organization: str """ - The server organization ID. + Instance Organization ID. """ project: str """ - The server project ID. + Instance Project ID. """ allowed_actions: List[ServerAction] """ - Provide as list of allowed actions on the server. + List of allowed actions on the Instance. """ tags: List[str] """ - The server associated tags. + Tags associated with the Instance. """ commercial_type: str """ - The server commercial type (eg. GP1-M). + Instance commercial type (eg. GP1-M). """ creation_date: Optional[datetime] """ - The server creation date. + Instance creation date. """ dynamic_ip_required: bool @@ -992,22 +1012,22 @@ class Server: hostname: str """ - The server host name. + Instance host name. """ image: Optional[Image] """ - Provide information on the server image. + Information about the Instance image. """ protected: bool """ - The server protection option is activated. + Defines whether the Instance protection option is activated. """ private_ip: Optional[str] """ - The server private IP address. + Private IP address of the Instance. """ public_ip: Optional[ServerIp] @@ -1017,73 +1037,73 @@ class Server: modification_date: Optional[datetime] """ - The server modification date. + Instance modification date. """ state: ServerState """ - The server state. + Instance state. """ location: Optional[ServerLocation] """ - The server location. + Instance location. """ ipv6: Optional[ServerIpv6] """ - The server IPv6 address. + Instance IPv6 address. """ bootscript: Optional[Bootscript] """ - The server bootscript. + Instance bootscript. :deprecated """ boot_type: BootType """ - The server boot type. + Instance boot type. """ volumes: Dict[str, VolumeServer] """ - The server volumes. + Instance volumes. """ security_group: Optional[SecurityGroupSummary] """ - The server security group. + Instance security group. """ maintenances: List[ServerMaintenance] """ - The server planned maintenances. + Instance planned maintenance. """ state_detail: str """ - The server state_detail. + Detailed information about the Instance state. """ arch: Arch """ - The server arch. + Instance architecture. """ placement_group: Optional[PlacementGroup] """ - The server placement group. + Instance placement group. """ private_nics: List[PrivateNIC] """ - The server private NICs. + Instance private NICs. """ zone: Zone """ - The zone in which is the server. + Zone in which the Instance is located. """ @@ -1095,8 +1115,8 @@ class ServerActionRequestVolumeBackupTemplate: volume_type: SnapshotVolumeType """ - The snapshot's volume type. - Overrides the volume_type of the snapshot for this volume. + Snapshot's volume type. + Overrides the `volume_type` of the snapshot for this volume. If omitted, the volume type of the original volume will be used. """ @@ -1114,12 +1134,12 @@ class ServerIp: id: str """ - The unique ID of the IP address. + Unique ID of the IP address. """ address: str """ - The server public IPv4 IP-Address. + Instance public IPv4 IP-Address. """ dynamic: bool @@ -1136,17 +1156,17 @@ class ServerIpv6: address: str """ - The server IPv6 IP-Address. + Instance IPv6 IP-Address. """ gateway: str """ - The IPv6 IP-addresses gateway. + IPv6 IP-addresses gateway. """ netmask: str """ - The IPv6 IP-addresses CIDR netmask. + IPv6 IP-addresses CIDR netmask. """ @@ -1194,7 +1214,7 @@ class ServerType: alt_names: List[str] """ - Alternative instance name if any. + Alternative Instance name, if any. """ per_volume_constraint: Optional[ServerTypeVolumeConstraintsByType] @@ -1229,12 +1249,12 @@ class ServerType: baremetal: bool """ - True if it is a baremetal instance. + True if it is a baremetal Instance. """ network: Optional[ServerTypeNetwork] """ - Network available for the instance. + Network available for the Instance. """ capabilities: Optional[ServerTypeCapabilities] @@ -1251,7 +1271,7 @@ class ServerTypeCapabilities: block_storage: Optional[bool] """ - True if server supports block storage. + Defines whether the Instance supports block storage. """ boot_types: List[BootType] @@ -1340,7 +1360,14 @@ class SetPlacementGroupResponse: @dataclass class SetPlacementGroupServersResponse: + """ + Set placement group servers response. + """ + servers: List[PlacementGroupServer] + """ + Instances attached to the placement group. + """ @dataclass @@ -1371,7 +1398,7 @@ class SetSecurityGroupRulesRequestRule: ip_range: str """ - The range of IP address this rules applies to. + Range of IP addresses these rules apply to. """ dest_port_from: Optional[int] @@ -1413,67 +1440,67 @@ class Snapshot: id: str """ - The snapshot ID. + Snapshot ID. """ name: str """ - The snapshot name. + Snapshot name. """ organization: str """ - The snapshot organization ID. + Snapshot Organization ID. """ project: str """ - The snapshot project ID. + Snapshot Project ID. """ tags: List[str] """ - The snapshot tags. + Snapshot tags. """ volume_type: VolumeVolumeType """ - The snapshot volume type. + Snapshot volume type. """ size: int """ - The snapshot size. + Snapshot size. """ state: SnapshotState """ - The snapshot state. + Snapshot state. """ base_volume: Optional[SnapshotBaseVolume] """ - The volume on which the snapshot is based on. + Volume on which the snapshot is based on. """ creation_date: Optional[datetime] """ - The snapshot creation date. + Snapshot creation date. """ modification_date: Optional[datetime] """ - The snapshot modification date. + Snapshot modification date. """ zone: Zone """ - The snapshot zone. + Snapshot zone. """ error_reason: Optional[str] """ - The reason for the failed snapshot import. + Reason for the failed snapshot import. """ @@ -1485,12 +1512,12 @@ class SnapshotBaseVolume: id: str """ - The volume ID on which the snapshot is based on. + Volume ID on which the snapshot is based. """ name: str """ - The volume name on which the snapshot is based on. + Volume name on which the snapshot is based on. """ @@ -1502,32 +1529,32 @@ class Task: id: str """ - The unique ID of the task. + Unique ID of the task. """ description: str """ - The description of the task. + Description of the task. """ progress: int """ - The progress of the task in percent. + Progress of the task in percent. """ started_at: Optional[datetime] """ - The task start date. + Task start date. """ terminated_at: Optional[datetime] """ - The task end date. + Task end date. """ status: TaskStatus """ - The task status. + Task status. """ href_from: str @@ -1536,7 +1563,7 @@ class Task: zone: Zone """ - The zone in which is the task. + Zone in which the task is excecuted. """ @@ -1552,7 +1579,14 @@ class UpdatePlacementGroupResponse: @dataclass class UpdatePlacementGroupServersResponse: + """ + Update placement group servers response. + """ + servers: List[PlacementGroupServer] + """ + Instances attached to the placement group. + """ @dataclass @@ -1573,12 +1607,12 @@ class Volume: id: str """ - The volume unique ID. + Volume unique ID. """ name: str """ - The volume name. + Volume name. """ export_uri: Optional[str] @@ -1589,52 +1623,52 @@ class Volume: size: int """ - The volume disk size. + Volume disk size. """ volume_type: VolumeVolumeType """ - The volume type. + Volume type. """ creation_date: Optional[datetime] """ - The volume creation date. + Volume creation date. """ modification_date: Optional[datetime] """ - The volume modification date. + Volume modification date. """ organization: str """ - The volume organization ID. + Volume Organization ID. """ project: str """ - The volume project ID. + Volume Project ID. """ tags: List[str] """ - The volume tags. + Volume tags. """ server: Optional[ServerSummary] """ - The server attached to the volume. + Instance attached to the volume. """ state: VolumeState """ - The volume state. + Volume state. """ zone: Zone """ - The zone in which is the volume. + Zone in which the volume is located. """ @@ -1680,7 +1714,7 @@ class VolumeServerTemplate: boot: bool """ - Force the server to boot on this volume. + Force the Instance to boot on this volume. """ name: str @@ -1700,7 +1734,7 @@ class VolumeServerTemplate: base_snapshot: str """ - The ID of the snapshot on which this volume will be based. + ID of the snapshot on which this volume will be based. """ organization: str @@ -1843,47 +1877,47 @@ class ListServersRequest: organization: Optional[str] """ - List only servers of this organization ID. + List only Instances of this Organization ID. """ project: Optional[str] """ - List only servers of this project ID. + List only Instances of this Project ID. """ name: Optional[str] """ - Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo"). + Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). """ private_ip: Optional[str] """ - List servers by private_ip. + List Instances by private_ip. """ without_ip: Optional[bool] """ - List servers that are not attached to a public IP. + List Instances that are not attached to a public IP. """ commercial_type: Optional[str] """ - List servers of this commercial type. + List Instances of this commercial type. """ state: Optional[ServerState] """ - List servers in this state. + List Instances in this state. """ tags: Optional[List[str]] """ - List servers with these exact tags (to filter with several tags, use commas to separate them). + List Instances with these exact tags (to filter with several tags, use commas to separate them). """ private_network: Optional[str] """ - List servers in this Private Network. + List Instances in this Private Network. """ order: Optional[ListServersRequestOrder] @@ -1911,7 +1945,7 @@ class GetServerRequest: server_id: str """ - UUID of the server you want to get. + UUID of the Instance you want to get. """ @@ -1934,18 +1968,18 @@ class ServerActionRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ action: ServerAction """ - The action to perform on the server. + Action to perform on the Instance. """ name: Optional[str] """ - The name of the backup you want to create. - The name of the backup you want to create. + Name of the backup you want to create. + Name of the backup you want to create. This field should only be specified when performing a backup action. """ @@ -1966,7 +2000,7 @@ class ListServerUserDataRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ @@ -1979,7 +2013,7 @@ class DeleteServerUserDataRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ key: str @@ -2075,7 +2109,7 @@ class CreateImageRequest: tags: Optional[List[str]] """ - The tags of the image. + Tags of the image. """ public: Optional[bool] @@ -2136,7 +2170,7 @@ class CreateSnapshotRequest: tags: Optional[List[str]] """ - The tags of the snapshot. + Tags of the snapshot. """ organization: Optional[str] @@ -2156,7 +2190,7 @@ class CreateSnapshotRequest: volume_type: SnapshotVolumeType """ - The volume type of the snapshot. + Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used. """ @@ -2212,7 +2246,7 @@ class ExportSnapshotRequest: snapshot_id: str """ - The snapshot ID. + Snapshot ID. """ bucket: str @@ -2250,12 +2284,12 @@ class ListVolumesRequest: organization: Optional[str] """ - Filter volume by organization ID. + Filter volume by Organization ID. """ project: Optional[str] """ - Filter volume by project ID. + Filter volume by Project ID. """ tags: Optional[List[str]] @@ -2278,12 +2312,12 @@ class CreateVolumeRequest: name: Optional[str] """ - The volume name. + Volume name. """ organization: Optional[str] """ - The volume organization ID. + Volume Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :deprecated @@ -2291,38 +2325,38 @@ class CreateVolumeRequest: project: Optional[str] """ - The volume project ID. + Volume Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. """ tags: Optional[List[str]] """ - The volume tags. + Volume tags. """ volume_type: VolumeVolumeType """ - The volume type. + Volume type. """ size: Optional[int] """ - The volume disk size, must be a multiple of 512. + Volume disk size, must be a multiple of 512. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. """ base_volume: Optional[str] """ - The ID of the volume on which this volume will be based. + ID of the volume on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. """ base_snapshot: Optional[str] """ - The ID of the snapshot on which this volume will be based. + ID of the snapshot on which this volume will be based. One-of ('from_'): at most one of 'size', 'base_volume', 'base_snapshot' could be set. """ @@ -2355,17 +2389,17 @@ class UpdateVolumeRequest: name: Optional[str] """ - The volume name. + Volume name. """ tags: Optional[List[str]] """ - The tags of the volume. + Tags of the volume. """ size: Optional[int] """ - The volume disk size, must be a multiple of 512. + Volume disk size, must be a multiple of 512. """ @@ -2396,12 +2430,12 @@ class ListSecurityGroupsRequest: organization: Optional[str] """ - The security group organization ID. + Security group Organization ID. """ project: Optional[str] """ - The security group project ID. + Security group Project ID. """ tags: Optional[List[str]] @@ -2459,12 +2493,12 @@ class CreateSecurityGroupRequest: tags: Optional[List[str]] """ - The tags of the security group. + Tags of the security group. """ organization_default: Optional[bool] """ - Whether this security group becomes the default security group for new instances. + Defines whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. :deprecated @@ -2472,7 +2506,7 @@ class CreateSecurityGroupRequest: project_default: Optional[bool] """ - Whether this security group becomes the default security group for new instances. + Whether this security group becomes the default security group for new Instances. One-of ('default_identifier'): at most one of 'organization_default', 'project_default' could be set. """ @@ -2577,17 +2611,17 @@ class CreateSecurityGroupRuleRequest: dest_port_from: Optional[int] """ - The beginning of the range of ports to apply this rule to (inclusive). + Beginning of the range of ports to apply this rule to (inclusive). """ dest_port_to: Optional[int] """ - The end of the range of ports to apply this rule to (inclusive). + End of the range of ports to apply this rule to (inclusive). """ position: int """ - The position of this rule in the security group rules list. + Position of this rule in the security group rules list. """ editable: bool @@ -2657,12 +2691,12 @@ class ListPlacementGroupsRequest: organization: Optional[str] """ - List only placement groups of this organization ID. + List only placement groups of this Organization ID. """ project: Optional[str] """ - List only placement groups of this project ID. + List only placement groups of this Project ID. """ tags: Optional[List[str]] @@ -2705,17 +2739,17 @@ class CreatePlacementGroupRequest: tags: Optional[List[str]] """ - The tags of the placement group. + Tags of the placement group. """ policy_mode: PlacementGroupPolicyMode """ - The operating mode of the placement group. + Operating mode of the placement group. """ policy_type: PlacementGroupPolicyType """ - The policy type of the placement group. + Policy type of the placement group. """ @@ -2773,17 +2807,17 @@ class UpdatePlacementGroupRequest: tags: Optional[List[str]] """ - The tags of the placement group. + Tags of the placement group. """ policy_mode: Optional[PlacementGroupPolicyMode] """ - The operating mode of the placement group. + Operating mode of the placement group. """ policy_type: Optional[PlacementGroupPolicyType] """ - The policy type of the placement group. + Policy type of the placement group. """ @@ -2808,6 +2842,9 @@ class GetPlacementGroupServersRequest: """ placement_group_id: str + """ + UUID of the placement group you want to get. + """ @dataclass @@ -2818,8 +2855,14 @@ class SetPlacementGroupServersRequest: """ placement_group_id: str + """ + UUID of the placement group you want to set. + """ - servers: Optional[List[str]] + servers: List[str] + """ + An array of the Instances' UUIDs you want to configure. + """ @dataclass @@ -2831,10 +2874,13 @@ class UpdatePlacementGroupServersRequest: placement_group_id: str """ - UUID of the placement group. + UUID of the placement group you want to update. """ servers: List[str] + """ + An array of the Instances' UUIDs you want to configure. + """ @dataclass @@ -2846,12 +2892,12 @@ class ListIpsRequest: project: Optional[str] """ - The project ID the IPs are reserved in. + Project ID in which the IPs are reserved. """ organization: Optional[str] """ - The organization ID the IPs are reserved in. + Organization ID in which the IPs are reserved. """ tags: Optional[List[str]] @@ -2884,7 +2930,7 @@ class CreateIpRequest: organization: Optional[str] """ - The organization ID the IP is reserved in. + Organization ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :deprecated @@ -2892,19 +2938,19 @@ class CreateIpRequest: project: Optional[str] """ - The project ID the IP is reserved in. + Project ID in which the IP is reserved. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. """ tags: Optional[List[str]] """ - The tags of the IP. + Tags of the IP. """ server: Optional[str] """ - UUID of the server you want to attach the IP to. + UUID of the Instance you want to attach the IP to. """ @@ -2917,7 +2963,7 @@ class GetIpRequest: ip: str """ - The IP ID or address to get. + IP ID or address to get. """ @@ -2955,7 +3001,7 @@ class DeleteIpRequest: ip: str """ - The ID or the address of the IP to delete. + ID or address of the IP to delete. """ @@ -2968,12 +3014,12 @@ class ListPrivateNICsRequest: server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ tags: Optional[List[str]] """ - The private NIC tags. + Private NIC tags. """ per_page: Optional[int] @@ -2996,7 +3042,7 @@ class CreatePrivateNICRequest: server_id: str """ - UUID of the server the private NIC will be attached to. + UUID of the Instance the private NIC will be attached to. """ private_network_id: str @@ -3006,7 +3052,7 @@ class CreatePrivateNICRequest: tags: Optional[List[str]] """ - The private NIC tags. + Private NIC tags. """ @@ -3019,12 +3065,12 @@ class GetPrivateNICRequest: server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ private_nic_id: str """ - The private NIC unique ID. + Private NIC unique ID. """ @@ -3037,12 +3083,12 @@ class UpdatePrivateNICRequest: server_id: str """ - UUID of the server the private NIC will be attached to. + UUID of the Instance the private NIC will be attached to. """ private_nic_id: str """ - The private NIC unique ID. + Private NIC unique ID. """ tags: Optional[List[str]] @@ -3060,12 +3106,12 @@ class DeletePrivateNICRequest: server_id: str """ - The server the private NIC is attached to. + Instance to which the private NIC is attached. """ private_nic_id: str """ - The private NIC unique ID. + Private NIC unique ID. """ diff --git a/scaleway/scaleway/instance/v1/types_private.py b/scaleway/scaleway/instance/v1/types_private.py index c135e4de0..5e9db72d1 100644 --- a/scaleway/scaleway/instance/v1/types_private.py +++ b/scaleway/scaleway/instance/v1/types_private.py @@ -97,27 +97,27 @@ class _CreateServerRequest: name: Optional[str] """ - The server name. + Instance name. """ dynamic_ip_required: Optional[bool] """ - Define if a dynamic IP is required for the instance. + Define if a dynamic IP is required for the Instance. """ commercial_type: str """ - Define the server commercial type (i.e. GP1-S). + Define the Instance commercial type (i.e. GP1-S). """ image: str """ - The server image ID or label. + Instance image ID or label. """ volumes: Optional[Dict[str, VolumeServerTemplate]] """ - The volumes attached to the server. + Volumes attached to the server. """ enable_ipv6: bool @@ -127,23 +127,23 @@ class _CreateServerRequest: public_ip: Optional[str] """ - The ID of the reserved IP to attach to the server. + ID of the reserved IP to attach to the server. """ boot_type: Optional[BootType] """ - The boot type to use. + Boot type to use. """ bootscript: Optional[str] """ - The bootscript ID to use when `boot_type` is set to `bootscript`. + Bootscript ID to use when `boot_type` is set to `bootscript`. :deprecated """ organization: Optional[str] """ - The server organization ID. + Instance Organization ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. :deprecated @@ -151,24 +151,24 @@ class _CreateServerRequest: project: Optional[str] """ - The server project ID. + Instance Project ID. One-of ('project_identifier'): at most one of 'organization', 'project' could be set. """ tags: Optional[List[str]] """ - The server tags. + Instance tags. """ security_group: Optional[str] """ - The security group ID. + Security group ID. """ placement_group: Optional[str] """ - Placement group ID if server must be part of a placement group. + Placement group ID if Instance must be part of a placement group. """ @@ -181,42 +181,42 @@ class _SetServerRequest: id: str """ - The server unique ID. + Instance unique ID. """ name: str """ - The server name. + Instance name. """ organization: Optional[str] """ - The server organization ID. + Instance Organization ID. """ project: Optional[str] """ - The server project ID. + Instance Project ID. """ allowed_actions: Optional[List[ServerAction]] """ - Provide as list of allowed actions on the server. + Provide a list of allowed actions on the server. """ tags: Optional[List[str]] """ - The server associated tags. + Tags associated with the Instance. """ commercial_type: str """ - The server commercial type (eg. GP1-M). + Instance commercial type (eg. GP1-M). """ creation_date: Optional[datetime] """ - The server creation date. + Instance creation date. """ dynamic_ip_required: bool @@ -231,22 +231,22 @@ class _SetServerRequest: hostname: str """ - The server host name. + Instance host name. """ image: Optional[Image] """ - Provide information on the server image. + Provide information on the Instance image. """ protected: bool """ - The server protection option is activated. + Instance protection option is activated. """ private_ip: Optional[str] """ - The server private IP address. + Instance private IP address. """ public_ip: Optional[ServerIp] @@ -256,68 +256,68 @@ class _SetServerRequest: modification_date: Optional[datetime] """ - The server modification date. + Instance modification date. """ state: ServerState """ - The server state. + Instance state. """ location: Optional[ServerLocation] """ - The server location. + Instance location. """ ipv6: Optional[ServerIpv6] """ - The server IPv6 address. + Instance IPv6 address. """ bootscript: Optional[Bootscript] """ - The server bootscript. + Instance bootscript. :deprecated """ boot_type: BootType """ - The server boot type. + Instance boot type. """ volumes: Optional[Dict[str, Volume]] """ - The server volumes. + Instance volumes. """ security_group: Optional[SecurityGroupSummary] """ - The server security group. + Instance security group. """ maintenances: Optional[List[ServerMaintenance]] """ - The server planned maintenances. + Instance planned maintenances. """ state_detail: str """ - The server state_detail. + Instance state_detail. """ arch: Arch """ - The server arch. + Instance architecture (refers to the CPU architecture used for the Instance, e.g. x86_64, arm64). """ placement_group: Optional[PlacementGroup] """ - The server placement group. + Instance placement group. """ private_nics: Optional[List[PrivateNIC]] """ - The server private NICs. + Instance private NICs. """ @@ -330,19 +330,19 @@ class _UpdateServerRequest: server_id: str """ - UUID of the server. + UUID of the Instance. """ name: Optional[str] """ - Name of the server. + Name of the Instance. """ boot_type: Optional[BootType] tags: Optional[List[str]] """ - Tags of the server. + Tags of the Instance. """ volumes: Optional[Dict[str, VolumeServerTemplate]] @@ -362,12 +362,12 @@ class _UpdateServerRequest: placement_group: Optional[str] """ - Placement group ID if server must be part of a placement group. + Placement group ID if Instance must be part of a placement group. """ private_nics: Optional[List[PrivateNIC]] """ - The server private NICs. + Instance private NICs. """ @@ -451,32 +451,32 @@ class _SetSecurityGroupRequest: id: str """ - The ID of the security group (will be ignored). + ID of the security group (will be ignored). """ name: str """ - The name of the security group. + Name of the security group. """ tags: Optional[List[str]] """ - The tags of the security group. + Tags of the security group. """ creation_date: Optional[datetime] """ - The creation date of the security group (will be ignored). + Creation date of the security group (will be ignored). """ modification_date: Optional[datetime] """ - The modification date of the security group (will be ignored). + Modification date of the security group (will be ignored). """ description: str """ - The description of the security group. + Description of the security group. """ enable_default_security: bool @@ -486,22 +486,22 @@ class _SetSecurityGroupRequest: inbound_default_policy: SecurityGroupPolicy """ - The default inbound policy. + Default inbound policy. """ outbound_default_policy: SecurityGroupPolicy """ - The default outbound policy. + Default outbound policy. """ organization: Optional[str] """ - The security groups organization ID. + Security groups Organization ID. """ project: Optional[str] """ - The security group project ID. + Security group Project ID. """ organization_default: Optional[bool] @@ -512,12 +512,12 @@ class _SetSecurityGroupRequest: project_default: bool """ - True use this security group for future instances created in this project. + True use this security group for future Instances created in this project. """ servers: Optional[List[ServerSummary]] """ - The servers attached to this security group. + Instances attached to this security group. """ stateful: bool