scaleway_async.marketplace.v2 package
Submodules
scaleway_async.marketplace.v2.api module
- class scaleway_async.marketplace.v2.api.MarketplaceV2API(client: Client, *, bypass_validation: bool = False)
Bases:
APIThis API allows you to find available images for use when launching a Scaleway Instance.
- async get_category(*, category_id: str) Category
Get a specific category. Get information about a specific category of the marketplace catalog, specified by its category_id (UUID format). :param category_id: :return:
CategoryUsage:
result = await api.get_category( category_id="example", )
- async get_image(*, image_id: str) Image
Get a specific marketplace image. Get detailed information about a marketplace image, specified by its image_id (UUID format). :param image_id: Display the image name. :return:
ImageUsage:
result = await api.get_image( image_id="example", )
- async get_local_image(*, local_image_id: str) LocalImage
Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its local_image_id (UUID format). :param local_image_id: :return:
LocalImageUsage:
result = await api.get_local_image( local_image_id="example", )
- async get_version(*, version_id: str) Version
Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its version_id (UUID format). :param version_id: :return:
VersionUsage:
result = await api.get_version( version_id="example", )
- async list_categories(*, page_size: int | None = None, page: int | None = None) ListCategoriesResponse
List existing image categories. Get a list of all existing categories. The output can be paginated. :param page_size: :param page: :return:
ListCategoriesResponseUsage:
result = await api.list_categories()
- async list_categories_all(*, page_size: int | None = None, page: int | None = None) List[Category]
List existing image categories. Get a list of all existing categories. The output can be paginated. :param page_size: :param page: :return:
List[Category]Usage:
result = await api.list_categories_all()
- async list_images(*, include_eol: bool, page_size: int | None = None, page: int | None = None, order_by: ListImagesRequestOrderBy | None = None, arch: str | None = None, category: str | None = None) ListImagesResponse
List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description. :param include_eol: Choose to include end-of-life images. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param arch: Choose for which machine architecture to return images. :param category: Choose the category of images to get. :return:
ListImagesResponseUsage:
result = await api.list_images( include_eol=False, )
- async list_images_all(*, include_eol: bool, page_size: int | None = None, page: int | None = None, order_by: ListImagesRequestOrderBy | None = None, arch: str | None = None, category: str | None = None) List[Image]
List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description. :param include_eol: Choose to include end-of-life images. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param arch: Choose for which machine architecture to return images. :param category: Choose the category of images to get. :return:
List[Image]Usage:
result = await api.list_images_all( include_eol=False, )
- async list_local_images(*, page_size: int | None = None, page: int | None = None, order_by: ListLocalImagesRequestOrderBy | None = None, zone: str | None = None, arch: str | None = None, image_id: str | None = None, version_id: str | None = None, image_label: str | None = None, type_: LocalImageType | None = None) ListLocalImagesResponse
List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its image_id (UUID format), version_id (UUID format) or image_label. Only one of these three parameters may be set. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param zone: Filter local images available on this Availability Zone. :param arch: Filter local images available for this machine architecture. :param image_id: Filter by image id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param version_id: Filter by version id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param image_label: Filter by image label. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param type_: Filter by type. :return:
ListLocalImagesResponseUsage:
result = await api.list_local_images()
- async list_local_images_all(*, page_size: int | None = None, page: int | None = None, order_by: ListLocalImagesRequestOrderBy | None = None, zone: str | None = None, arch: str | None = None, image_id: str | None = None, version_id: str | None = None, image_label: str | None = None, type_: LocalImageType | None = None) List[LocalImage]
List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its image_id (UUID format), version_id (UUID format) or image_label. Only one of these three parameters may be set. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param zone: Filter local images available on this Availability Zone. :param arch: Filter local images available for this machine architecture. :param image_id: Filter by image id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param version_id: Filter by version id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param image_label: Filter by image label. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param type_: Filter by type. :return:
List[LocalImage]Usage:
result = await api.list_local_images_all()
- async list_versions(*, image_id: str, page_size: int | None = None, page: int | None = None, order_by: ListVersionsRequestOrderBy | None = None) ListVersionsResponse
List versions of an Image. Get a list of all available version of an image, specified by its image_id (UUID format). :param image_id: :param page_size: :param page: :param order_by: :return:
ListVersionsResponseUsage:
result = await api.list_versions( image_id="example", )
- async list_versions_all(*, image_id: str, page_size: int | None = None, page: int | None = None, order_by: ListVersionsRequestOrderBy | None = None) List[Version]
List versions of an Image. Get a list of all available version of an image, specified by its image_id (UUID format). :param image_id: :param page_size: :param page: :param order_by: :return:
List[Version]Usage:
result = await api.list_versions_all( image_id="example", )
scaleway_async.marketplace.v2.marshalling module
- scaleway_async.marketplace.v2.marshalling.unmarshal_ListCategoriesResponse(data: Any) ListCategoriesResponse
- scaleway_async.marketplace.v2.marshalling.unmarshal_ListImagesResponse(data: Any) ListImagesResponse
- scaleway_async.marketplace.v2.marshalling.unmarshal_ListLocalImagesResponse(data: Any) ListLocalImagesResponse
- scaleway_async.marketplace.v2.marshalling.unmarshal_ListVersionsResponse(data: Any) ListVersionsResponse
- scaleway_async.marketplace.v2.marshalling.unmarshal_LocalImage(data: Any) LocalImage
scaleway_async.marketplace.v2.types module
- class scaleway_async.marketplace.v2.types.Category(id: 'str', name: 'str', description: 'str')
Bases:
object- description: str
- id: str
- name: str
- class scaleway_async.marketplace.v2.types.GetCategoryRequest(category_id: 'str')
Bases:
object- category_id: str
- class scaleway_async.marketplace.v2.types.GetImageRequest(image_id: 'str')
Bases:
object- image_id: str
Display the image name.
- class scaleway_async.marketplace.v2.types.GetLocalImageRequest(local_image_id: 'str')
Bases:
object- local_image_id: str
- class scaleway_async.marketplace.v2.types.GetVersionRequest(version_id: 'str')
Bases:
object- version_id: str
- class scaleway_async.marketplace.v2.types.Image(id: 'str', name: 'str', description: 'str', logo: 'str', categories: 'List[str]', label: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, valid_until: 'Optional[datetime]' = None)
Bases:
object- categories: List[str]
List of categories this image belongs to.
- created_at: datetime | None = None
Creation date of this image.
- description: str
Text description of this image.
- id: str
UUID of this image.
- label: str
Typically an identifier for a distribution (ex. “ubuntu_focal”).
This label can be used in the image field of the server creation request.
- logo: str
URL of this image’s logo.
- name: str
Name of the image.
- updated_at: datetime | None = None
Date of the last modification of this image.
- valid_until: datetime | None = None
Expiration date of this image.
- class scaleway_async.marketplace.v2.types.ListCategoriesRequest(page_size: 'Optional[int]' = None, page: 'Optional[int]' = None)
Bases:
object- page: int | None = None
- page_size: int | None = None
- class scaleway_async.marketplace.v2.types.ListCategoriesResponse(categories: 'List[Category]', total_count: 'int')
Bases:
object- total_count: int
- class scaleway_async.marketplace.v2.types.ListImagesRequest(include_eol: 'bool', page_size: 'Optional[int]' = 0, page: 'Optional[int]' = 0, order_by: 'Optional[ListImagesRequestOrderBy]' = <ListImagesRequestOrderBy.NAME_ASC: 'name_asc'>, arch: 'Optional[str]' = None, category: 'Optional[str]' = None)
Bases:
object- arch: str | None = None
Choose for which machine architecture to return images.
- category: str | None = None
Choose the category of images to get.
- include_eol: bool
Choose to include end-of-life images.
- order_by: ListImagesRequestOrderBy | None = 'name_asc'
Ordering to use.
- page: int | None = 0
A positive integer to choose the page to display.
- page_size: int | None = 0
A positive integer lower or equal to 100 to select the number of items to display.
- class scaleway_async.marketplace.v2.types.ListImagesRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- CREATED_AT_ASC = 'created_at_asc'
- CREATED_AT_DESC = 'created_at_desc'
- NAME_ASC = 'name_asc'
- NAME_DESC = 'name_desc'
- UPDATED_AT_ASC = 'updated_at_asc'
- UPDATED_AT_DESC = 'updated_at_desc'
- class scaleway_async.marketplace.v2.types.ListImagesResponse(images: 'List[Image]', total_count: 'int')
Bases:
object- total_count: int
- class scaleway_async.marketplace.v2.types.ListLocalImagesRequest(page_size: 'Optional[int]' = 0, page: 'Optional[int]' = 0, order_by: 'Optional[ListLocalImagesRequestOrderBy]' = <ListLocalImagesRequestOrderBy.TYPE_ASC: 'type_asc'>, zone: 'Optional[ScwZone]' = None, arch: 'Optional[str]' = None, type_: 'Optional[LocalImageType]' = <LocalImageType.UNKNOWN_TYPE: 'unknown_type'>, image_id: 'Optional[str]' = None, version_id: 'Optional[str]' = None, image_label: 'Optional[str]' = None)
Bases:
object- arch: str | None = None
Filter local images available for this machine architecture.
- image_id: str | None = None
- image_label: str | None = None
- order_by: ListLocalImagesRequestOrderBy | None = 'type_asc'
Ordering to use.
- page: int | None = 0
A positive integer to choose the page to display.
- page_size: int | None = 0
A positive integer lower or equal to 100 to select the number of items to display.
- type_: LocalImageType | None = 'unknown_type'
Filter by type.
- version_id: str | None = None
- zone: str | None = None
Filter local images available on this Availability Zone.
- class scaleway_async.marketplace.v2.types.ListLocalImagesRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- CREATED_AT_ASC = 'created_at_asc'
- CREATED_AT_DESC = 'created_at_desc'
- TYPE_ASC = 'type_asc'
- TYPE_DESC = 'type_desc'
- class scaleway_async.marketplace.v2.types.ListLocalImagesResponse(local_images: 'List[LocalImage]', total_count: 'int')
Bases:
object- local_images: List[LocalImage]
- total_count: int
- class scaleway_async.marketplace.v2.types.ListVersionsRequest(image_id: 'str', page_size: 'Optional[int]' = None, page: 'Optional[int]' = None, order_by: 'Optional[ListVersionsRequestOrderBy]' = None)
Bases:
object- image_id: str
- order_by: ListVersionsRequestOrderBy | None = None
- page: int | None = None
- page_size: int | None = None
- class scaleway_async.marketplace.v2.types.ListVersionsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- CREATED_AT_ASC = 'created_at_asc'
- CREATED_AT_DESC = 'created_at_desc'
- class scaleway_async.marketplace.v2.types.ListVersionsResponse(versions: 'List[Version]', total_count: 'int')
Bases:
object- total_count: int
- class scaleway_async.marketplace.v2.types.LocalImage(id: 'str', compatible_commercial_types: 'List[str]', arch: 'str', zone: 'ScwZone', label: 'str', type_: 'LocalImageType')
Bases:
object- arch: str
Supported architecture for this local image.
- compatible_commercial_types: List[str]
List of all commercial types that are compatible with this local image.
- id: str
Version you will typically use to define an image in an API call.
- label: str
This label can be used in the image field of the server creation request.
- type_: LocalImageType
Type of this local image.
- zone: str
Availability Zone where this local image is available.
- class scaleway_async.marketplace.v2.types.LocalImageType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- INSTANCE_LOCAL = 'instance_local'
- INSTANCE_SBS = 'instance_sbs'
- UNKNOWN_TYPE = 'unknown_type'
- class scaleway_async.marketplace.v2.types.Version(id: 'str', name: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, published_at: 'Optional[datetime]' = None)
Bases:
object- created_at: datetime | None = None
Creation date of this image version.
- id: str
UUID of this version.
- name: str
Name of this version.
- published_at: datetime | None = None
Date this version was officially published.
- updated_at: datetime | None = None
Date of the last modification of this version.
Module contents
- class scaleway_async.marketplace.v2.Category(id: 'str', name: 'str', description: 'str')
Bases:
object- description: str
- id: str
- name: str
- class scaleway_async.marketplace.v2.GetCategoryRequest(category_id: 'str')
Bases:
object- category_id: str
- class scaleway_async.marketplace.v2.GetImageRequest(image_id: 'str')
Bases:
object- image_id: str
Display the image name.
- class scaleway_async.marketplace.v2.GetLocalImageRequest(local_image_id: 'str')
Bases:
object- local_image_id: str
- class scaleway_async.marketplace.v2.GetVersionRequest(version_id: 'str')
Bases:
object- version_id: str
- class scaleway_async.marketplace.v2.Image(id: 'str', name: 'str', description: 'str', logo: 'str', categories: 'List[str]', label: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, valid_until: 'Optional[datetime]' = None)
Bases:
object- categories: List[str]
List of categories this image belongs to.
- created_at: datetime | None = None
Creation date of this image.
- description: str
Text description of this image.
- id: str
UUID of this image.
- label: str
Typically an identifier for a distribution (ex. “ubuntu_focal”).
This label can be used in the image field of the server creation request.
- logo: str
URL of this image’s logo.
- name: str
Name of the image.
- updated_at: datetime | None = None
Date of the last modification of this image.
- valid_until: datetime | None = None
Expiration date of this image.
- class scaleway_async.marketplace.v2.ListCategoriesRequest(page_size: 'Optional[int]' = None, page: 'Optional[int]' = None)
Bases:
object- page: int | None = None
- page_size: int | None = None
- class scaleway_async.marketplace.v2.ListCategoriesResponse(categories: 'List[Category]', total_count: 'int')
Bases:
object- total_count: int
- class scaleway_async.marketplace.v2.ListImagesRequest(include_eol: 'bool', page_size: 'Optional[int]' = 0, page: 'Optional[int]' = 0, order_by: 'Optional[ListImagesRequestOrderBy]' = <ListImagesRequestOrderBy.NAME_ASC: 'name_asc'>, arch: 'Optional[str]' = None, category: 'Optional[str]' = None)
Bases:
object- arch: str | None = None
Choose for which machine architecture to return images.
- category: str | None = None
Choose the category of images to get.
- include_eol: bool
Choose to include end-of-life images.
- order_by: ListImagesRequestOrderBy | None = 'name_asc'
Ordering to use.
- page: int | None = 0
A positive integer to choose the page to display.
- page_size: int | None = 0
A positive integer lower or equal to 100 to select the number of items to display.
- class scaleway_async.marketplace.v2.ListImagesRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- CREATED_AT_ASC = 'created_at_asc'
- CREATED_AT_DESC = 'created_at_desc'
- NAME_ASC = 'name_asc'
- NAME_DESC = 'name_desc'
- UPDATED_AT_ASC = 'updated_at_asc'
- UPDATED_AT_DESC = 'updated_at_desc'
- class scaleway_async.marketplace.v2.ListImagesResponse(images: 'List[Image]', total_count: 'int')
Bases:
object- total_count: int
- class scaleway_async.marketplace.v2.ListLocalImagesRequest(page_size: 'Optional[int]' = 0, page: 'Optional[int]' = 0, order_by: 'Optional[ListLocalImagesRequestOrderBy]' = <ListLocalImagesRequestOrderBy.TYPE_ASC: 'type_asc'>, zone: 'Optional[ScwZone]' = None, arch: 'Optional[str]' = None, type_: 'Optional[LocalImageType]' = <LocalImageType.UNKNOWN_TYPE: 'unknown_type'>, image_id: 'Optional[str]' = None, version_id: 'Optional[str]' = None, image_label: 'Optional[str]' = None)
Bases:
object- arch: str | None = None
Filter local images available for this machine architecture.
- image_id: str | None = None
- image_label: str | None = None
- order_by: ListLocalImagesRequestOrderBy | None = 'type_asc'
Ordering to use.
- page: int | None = 0
A positive integer to choose the page to display.
- page_size: int | None = 0
A positive integer lower or equal to 100 to select the number of items to display.
- type_: LocalImageType | None = 'unknown_type'
Filter by type.
- version_id: str | None = None
- zone: str | None = None
Filter local images available on this Availability Zone.
- class scaleway_async.marketplace.v2.ListLocalImagesRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- CREATED_AT_ASC = 'created_at_asc'
- CREATED_AT_DESC = 'created_at_desc'
- TYPE_ASC = 'type_asc'
- TYPE_DESC = 'type_desc'
- class scaleway_async.marketplace.v2.ListLocalImagesResponse(local_images: 'List[LocalImage]', total_count: 'int')
Bases:
object- local_images: List[LocalImage]
- total_count: int
- class scaleway_async.marketplace.v2.ListVersionsRequest(image_id: 'str', page_size: 'Optional[int]' = None, page: 'Optional[int]' = None, order_by: 'Optional[ListVersionsRequestOrderBy]' = None)
Bases:
object- image_id: str
- order_by: ListVersionsRequestOrderBy | None = None
- page: int | None = None
- page_size: int | None = None
- class scaleway_async.marketplace.v2.ListVersionsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- CREATED_AT_ASC = 'created_at_asc'
- CREATED_AT_DESC = 'created_at_desc'
- class scaleway_async.marketplace.v2.ListVersionsResponse(versions: 'List[Version]', total_count: 'int')
Bases:
object- total_count: int
- class scaleway_async.marketplace.v2.LocalImage(id: 'str', compatible_commercial_types: 'List[str]', arch: 'str', zone: 'ScwZone', label: 'str', type_: 'LocalImageType')
Bases:
object- arch: str
Supported architecture for this local image.
- compatible_commercial_types: List[str]
List of all commercial types that are compatible with this local image.
- id: str
Version you will typically use to define an image in an API call.
- label: str
This label can be used in the image field of the server creation request.
- type_: LocalImageType
Type of this local image.
- zone: str
Availability Zone where this local image is available.
- class scaleway_async.marketplace.v2.LocalImageType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)
Bases:
str,Enum- INSTANCE_LOCAL = 'instance_local'
- INSTANCE_SBS = 'instance_sbs'
- UNKNOWN_TYPE = 'unknown_type'
- class scaleway_async.marketplace.v2.MarketplaceV2API(client: Client, *, bypass_validation: bool = False)
Bases:
APIThis API allows you to find available images for use when launching a Scaleway Instance.
- async get_category(*, category_id: str) Category
Get a specific category. Get information about a specific category of the marketplace catalog, specified by its category_id (UUID format). :param category_id: :return:
CategoryUsage:
result = await api.get_category( category_id="example", )
- async get_image(*, image_id: str) Image
Get a specific marketplace image. Get detailed information about a marketplace image, specified by its image_id (UUID format). :param image_id: Display the image name. :return:
ImageUsage:
result = await api.get_image( image_id="example", )
- async get_local_image(*, local_image_id: str) LocalImage
Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its local_image_id (UUID format). :param local_image_id: :return:
LocalImageUsage:
result = await api.get_local_image( local_image_id="example", )
- async get_version(*, version_id: str) Version
Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its version_id (UUID format). :param version_id: :return:
VersionUsage:
result = await api.get_version( version_id="example", )
- async list_categories(*, page_size: int | None = None, page: int | None = None) ListCategoriesResponse
List existing image categories. Get a list of all existing categories. The output can be paginated. :param page_size: :param page: :return:
ListCategoriesResponseUsage:
result = await api.list_categories()
- async list_categories_all(*, page_size: int | None = None, page: int | None = None) List[Category]
List existing image categories. Get a list of all existing categories. The output can be paginated. :param page_size: :param page: :return:
List[Category]Usage:
result = await api.list_categories_all()
- async list_images(*, include_eol: bool, page_size: int | None = None, page: int | None = None, order_by: ListImagesRequestOrderBy | None = None, arch: str | None = None, category: str | None = None) ListImagesResponse
List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description. :param include_eol: Choose to include end-of-life images. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param arch: Choose for which machine architecture to return images. :param category: Choose the category of images to get. :return:
ListImagesResponseUsage:
result = await api.list_images( include_eol=False, )
- async list_images_all(*, include_eol: bool, page_size: int | None = None, page: int | None = None, order_by: ListImagesRequestOrderBy | None = None, arch: str | None = None, category: str | None = None) List[Image]
List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description. :param include_eol: Choose to include end-of-life images. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param arch: Choose for which machine architecture to return images. :param category: Choose the category of images to get. :return:
List[Image]Usage:
result = await api.list_images_all( include_eol=False, )
- async list_local_images(*, page_size: int | None = None, page: int | None = None, order_by: ListLocalImagesRequestOrderBy | None = None, zone: str | None = None, arch: str | None = None, image_id: str | None = None, version_id: str | None = None, image_label: str | None = None, type_: LocalImageType | None = None) ListLocalImagesResponse
List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its image_id (UUID format), version_id (UUID format) or image_label. Only one of these three parameters may be set. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param zone: Filter local images available on this Availability Zone. :param arch: Filter local images available for this machine architecture. :param image_id: Filter by image id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param version_id: Filter by version id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param image_label: Filter by image label. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param type_: Filter by type. :return:
ListLocalImagesResponseUsage:
result = await api.list_local_images()
- async list_local_images_all(*, page_size: int | None = None, page: int | None = None, order_by: ListLocalImagesRequestOrderBy | None = None, zone: str | None = None, arch: str | None = None, image_id: str | None = None, version_id: str | None = None, image_label: str | None = None, type_: LocalImageType | None = None) List[LocalImage]
List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its image_id (UUID format), version_id (UUID format) or image_label. Only one of these three parameters may be set. :param page_size: A positive integer lower or equal to 100 to select the number of items to display. :param page: A positive integer to choose the page to display. :param order_by: Ordering to use. :param zone: Filter local images available on this Availability Zone. :param arch: Filter local images available for this machine architecture. :param image_id: Filter by image id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param version_id: Filter by version id. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param image_label: Filter by image label. One-Of (‘scope’): at most one of ‘image_id’, ‘version_id’, ‘image_label’ could be set. :param type_: Filter by type. :return:
List[LocalImage]Usage:
result = await api.list_local_images_all()
- async list_versions(*, image_id: str, page_size: int | None = None, page: int | None = None, order_by: ListVersionsRequestOrderBy | None = None) ListVersionsResponse
List versions of an Image. Get a list of all available version of an image, specified by its image_id (UUID format). :param image_id: :param page_size: :param page: :param order_by: :return:
ListVersionsResponseUsage:
result = await api.list_versions( image_id="example", )
- async list_versions_all(*, image_id: str, page_size: int | None = None, page: int | None = None, order_by: ListVersionsRequestOrderBy | None = None) List[Version]
List versions of an Image. Get a list of all available version of an image, specified by its image_id (UUID format). :param image_id: :param page_size: :param page: :param order_by: :return:
List[Version]Usage:
result = await api.list_versions_all( image_id="example", )
- class scaleway_async.marketplace.v2.Version(id: 'str', name: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, published_at: 'Optional[datetime]' = None)
Bases:
object- created_at: datetime | None = None
Creation date of this image version.
- id: str
UUID of this version.
- name: str
Name of this version.
- published_at: datetime | None = None
Date this version was officially published.
- updated_at: datetime | None = None
Date of the last modification of this version.