From eca2d392e19af87d19e799dbf6ddc1ac8a7ef8f4 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Thu, 5 Dec 2024 15:17:49 +0000 Subject: [PATCH] feat: update generated APIs --- .../scaleway_async/mnq/v1beta1/api.py | 106 +++++++++--------- .../scaleway_async/mnq/v1beta1/types.py | 62 +++++----- scaleway/scaleway/mnq/v1beta1/api.py | 106 +++++++++--------- scaleway/scaleway/mnq/v1beta1/types.py | 62 +++++----- 4 files changed, 168 insertions(+), 168 deletions(-) diff --git a/scaleway-async/scaleway_async/mnq/v1beta1/api.py b/scaleway-async/scaleway_async/mnq/v1beta1/api.py index fa99fd513..0711f2549 100644 --- a/scaleway-async/scaleway_async/mnq/v1beta1/api.py +++ b/scaleway-async/scaleway_async/mnq/v1beta1/api.py @@ -68,7 +68,7 @@ class MnqV1Beta1NatsAPI(API): """ - This API allows you to manage Scaleway Messaging and Queuing NATS accounts. + This API allows you to manage Scaleway NATS accounts. """ async def create_nats_account( @@ -506,7 +506,7 @@ async def list_nats_credentials_all( class MnqV1Beta1SnsAPI(API): """ - This API allows you to manage your Scaleway Messaging and Queuing SNS brokers. + This API allows you to manage your Scaleway Topics and Events. """ async def activate_sns( @@ -516,10 +516,10 @@ async def activate_sns( project_id: Optional[str] = None, ) -> SnsInfo: """ - Activate SNS. - Activate SNS for the specified Project ID. SNS must be activated before any usage. Activating SNS does not trigger any billing, and you can deactivate at any time. + Activate Topics and Events. + Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to activate the SNS service. + :param project_id: Project on which to activate the Topics and Events service. :return: :class:`SnsInfo ` Usage: @@ -554,10 +554,10 @@ async def get_sns_info( project_id: Optional[str] = None, ) -> SnsInfo: """ - Get SNS info. - Retrieve the SNS information of the specified Project ID. Informations include the activation status and the SNS API endpoint URL. + Get Topics and Events info. + Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project to retrieve SNS info from. + :param project_id: Project to retrieve Topics and Events info from. :return: :class:`SnsInfo ` Usage: @@ -588,10 +588,10 @@ async def deactivate_sns( project_id: Optional[str] = None, ) -> SnsInfo: """ - Deactivate SNS. - Deactivate SNS for the specified Project ID.You must delete all topics and credentials before this call or you need to set the force_delete parameter. + Deactivate Topics and Events. + Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to deactivate the SNS service. + :param project_id: Project on which to deactivate the Topics and Events service. :return: :class:`SnsInfo ` Usage: @@ -628,10 +628,10 @@ async def create_sns_credentials( permissions: Optional[SnsPermissions] = None, ) -> SnsCredentials: """ - Create SNS credentials. - Create a set of credentials for SNS, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. + Create Topics and Events credentials. + Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project containing the SNS credentials. + :param project_id: Project containing the Topics and Events credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: :class:`SnsCredentials ` @@ -670,8 +670,8 @@ async def delete_sns_credentials( region: Optional[Region] = None, ) -> None: """ - Delete SNS credentials. - Delete a set of SNS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SNS. + Delete Topics and Events credentials. + Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events. :param sns_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config. @@ -706,9 +706,9 @@ async def update_sns_credentials( permissions: Optional[SnsPermissions] = None, ) -> SnsCredentials: """ - Update SNS credentials. - Update a set of SNS credentials. You can update the credentials' name, or their permissions. - :param sns_credentials_id: ID of the SNS credentials to update. + Update Topics and Events credentials. + Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions. + :param sns_credentials_id: ID of the Topics and Events credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. @@ -753,9 +753,9 @@ async def get_sns_credentials( region: Optional[Region] = None, ) -> SnsCredentials: """ - Get SNS credentials. + Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. - :param sns_credentials_id: ID of the SNS credentials to get. + :param sns_credentials_id: ID of the Topics and Events credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`SnsCredentials ` @@ -792,10 +792,10 @@ async def list_sns_credentials( order_by: Optional[ListSnsCredentialsRequestOrderBy] = None, ) -> ListSnsCredentialsResponse: """ - List SNS credentials. - List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Topics and Events credentials. + List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SNS credentials in this Project. + :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. @@ -835,10 +835,10 @@ async def list_sns_credentials_all( order_by: Optional[ListSnsCredentialsRequestOrderBy] = None, ) -> List[SnsCredentials]: """ - List SNS credentials. - List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Topics and Events credentials. + List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SNS credentials in this Project. + :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. @@ -866,7 +866,7 @@ async def list_sns_credentials_all( class MnqV1Beta1SqsAPI(API): """ - This API allows you to manage your Scaleway Messaging and Queuing SQS brokers. + This API allows you to manage your Scaleway Queues. """ async def activate_sqs( @@ -876,10 +876,10 @@ async def activate_sqs( project_id: Optional[str] = None, ) -> SqsInfo: """ - Activate SQS. - Activate SQS for the specified Project ID. SQS must be activated before any usage such as creating credentials and queues. Activating SQS does not trigger any billing, and you can deactivate at any time. + Activate Queues. + Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to activate the SQS service. + :param project_id: Project on which to activate the Queues service. :return: :class:`SqsInfo ` Usage: @@ -914,10 +914,10 @@ async def get_sqs_info( project_id: Optional[str] = None, ) -> SqsInfo: """ - Get SQS info. - Retrieve the SQS information of the specified Project ID. Informations include the activation status and the SQS API endpoint URL. + Get Queues info. + Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project to retrieve SQS info from. + :param project_id: Project to retrieve Queues info from. :return: :class:`SqsInfo ` Usage: @@ -948,10 +948,10 @@ async def deactivate_sqs( project_id: Optional[str] = None, ) -> SqsInfo: """ - Deactivate SQS. - Deactivate SQS for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. + Deactivate Queues. + Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to deactivate the SQS service. + :param project_id: Project on which to deactivate the Queues service. :return: :class:`SqsInfo ` Usage: @@ -988,10 +988,10 @@ async def create_sqs_credentials( permissions: Optional[SqsPermissions] = None, ) -> SqsCredentials: """ - Create SQS credentials. - Create a set of credentials for SQS, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. + Create Queues credentials. + Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project containing the SQS credentials. + :param project_id: Project containing the Queues credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: :class:`SqsCredentials ` @@ -1030,8 +1030,8 @@ async def delete_sqs_credentials( region: Optional[Region] = None, ) -> None: """ - Delete SQS credentials. - Delete a set of SQS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SQS. + Delete Queues credentials. + Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues. :param sqs_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config. @@ -1066,9 +1066,9 @@ async def update_sqs_credentials( permissions: Optional[SqsPermissions] = None, ) -> SqsCredentials: """ - Update SQS credentials. - Update a set of SQS credentials. You can update the credentials' name, or their permissions. - :param sqs_credentials_id: ID of the SQS credentials to update. + Update Queues credentials. + Update a set of Queues credentials. You can update the credentials' name, or their permissions. + :param sqs_credentials_id: ID of the Queues credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. @@ -1113,9 +1113,9 @@ async def get_sqs_credentials( region: Optional[Region] = None, ) -> SqsCredentials: """ - Get SQS credentials. + Get Queues credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. - :param sqs_credentials_id: ID of the SQS credentials to get. + :param sqs_credentials_id: ID of the Queues credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`SqsCredentials ` @@ -1152,10 +1152,10 @@ async def list_sqs_credentials( order_by: Optional[ListSqsCredentialsRequestOrderBy] = None, ) -> ListSqsCredentialsResponse: """ - List SQS credentials. - List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Queues credentials. + List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SQS credentials in this Project. + :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. @@ -1195,10 +1195,10 @@ async def list_sqs_credentials_all( order_by: Optional[ListSqsCredentialsRequestOrderBy] = None, ) -> List[SqsCredentials]: """ - List SQS credentials. - List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Queues credentials. + List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SQS credentials in this Project. + :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. diff --git a/scaleway-async/scaleway_async/mnq/v1beta1/types.py b/scaleway-async/scaleway_async/mnq/v1beta1/types.py index e8f0a0d9f..0ef51e472 100644 --- a/scaleway-async/scaleway_async/mnq/v1beta1/types.py +++ b/scaleway-async/scaleway_async/mnq/v1beta1/types.py @@ -98,7 +98,7 @@ class File: class SnsPermissions: can_publish: Optional[bool] """ - Defines whether the credentials bearer can publish messages to the service (publish to SNS topics). + Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics). """ can_receive: Optional[bool] @@ -108,7 +108,7 @@ class SnsPermissions: can_manage: Optional[bool] """ - Defines whether the credentials bearer can manage the associated SNS topics or subscriptions. + Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions. """ @@ -116,17 +116,17 @@ class SnsPermissions: class SqsPermissions: can_publish: Optional[bool] """ - Defines whether the credentials bearer can publish messages to the service (send messages to SQS queues). + Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues). """ can_receive: Optional[bool] """ - Defines whether the credentials bearer can receive messages from SQS queues. + Defines whether the credentials bearer can receive messages from Queues queues. """ can_manage: Optional[bool] """ - Defines whether the credentials bearer can manage the associated SQS queues. + Defines whether the credentials bearer can manage the associated Queues queues. """ @@ -235,7 +235,7 @@ class SnsCredentials: secret_key: str """ - Secret key ID (Only returned by **Create SNS Credentials** call). + Secret key ID (Only returned by **Create Topics and Events Credentials** call). """ secret_checksum: str @@ -288,7 +288,7 @@ class SqsCredentials: secret_key: str """ - Secret key ID (Only returned by **Create SQS Credentials** call). + Secret key ID (Only returned by **Create Queues Credentials** call). """ secret_checksum: str @@ -347,7 +347,7 @@ class ListSnsCredentialsResponse: sns_credentials: List[SnsCredentials] """ - SNS credentials on this page. + Topics and Events credentials on this page. """ @@ -360,7 +360,7 @@ class ListSqsCredentialsResponse: sqs_credentials: List[SqsCredentials] """ - SQS credentials on this page. + Queues credentials on this page. """ @@ -540,7 +540,7 @@ class SnsApiActivateSnsRequest: project_id: Optional[str] """ - Project on which to activate the SNS service. + Project on which to activate the Topics and Events service. """ @@ -553,7 +553,7 @@ class SnsApiCreateSnsCredentialsRequest: project_id: Optional[str] """ - Project containing the SNS credentials. + Project containing the Topics and Events credentials. """ name: Optional[str] @@ -576,7 +576,7 @@ class SnsApiDeactivateSnsRequest: project_id: Optional[str] """ - Project on which to deactivate the SNS service. + Project on which to deactivate the Topics and Events service. """ @@ -597,7 +597,7 @@ class SnsApiDeleteSnsCredentialsRequest: class SnsApiGetSnsCredentialsRequest: sns_credentials_id: str """ - ID of the SNS credentials to get. + ID of the Topics and Events credentials to get. """ region: Optional[Region] @@ -615,7 +615,7 @@ class SnsApiGetSnsInfoRequest: project_id: Optional[str] """ - Project to retrieve SNS info from. + Project to retrieve Topics and Events info from. """ @@ -628,7 +628,7 @@ class SnsApiListSnsCredentialsRequest: project_id: Optional[str] """ - Include only SNS credentials in this Project. + Include only Topics and Events credentials in this Project. """ page: Optional[int] @@ -651,7 +651,7 @@ class SnsApiListSnsCredentialsRequest: class SnsApiUpdateSnsCredentialsRequest: sns_credentials_id: str """ - ID of the SNS credentials to update. + ID of the Topics and Events credentials to update. """ region: Optional[Region] @@ -684,22 +684,22 @@ class SnsInfo: status: SnsInfoStatus """ - SNS activation status. + Topics and Events activation status. """ sns_endpoint_url: str """ - Endpoint of the SNS service for this region and project. + Endpoint of the Topics and Events service for this region and project. """ created_at: Optional[datetime] """ - SNS creation date. + Topics and Events creation date. """ updated_at: Optional[datetime] """ - SNS last modification date. + Topics and Events last modification date. """ @@ -712,7 +712,7 @@ class SqsApiActivateSqsRequest: project_id: Optional[str] """ - Project on which to activate the SQS service. + Project on which to activate the Queues service. """ @@ -725,7 +725,7 @@ class SqsApiCreateSqsCredentialsRequest: project_id: Optional[str] """ - Project containing the SQS credentials. + Project containing the Queues credentials. """ name: Optional[str] @@ -748,7 +748,7 @@ class SqsApiDeactivateSqsRequest: project_id: Optional[str] """ - Project on which to deactivate the SQS service. + Project on which to deactivate the Queues service. """ @@ -769,7 +769,7 @@ class SqsApiDeleteSqsCredentialsRequest: class SqsApiGetSqsCredentialsRequest: sqs_credentials_id: str """ - ID of the SQS credentials to get. + ID of the Queues credentials to get. """ region: Optional[Region] @@ -787,7 +787,7 @@ class SqsApiGetSqsInfoRequest: project_id: Optional[str] """ - Project to retrieve SQS info from. + Project to retrieve Queues info from. """ @@ -800,7 +800,7 @@ class SqsApiListSqsCredentialsRequest: project_id: Optional[str] """ - Include only SQS credentials in this Project. + Include only Queues credentials in this Project. """ page: Optional[int] @@ -823,7 +823,7 @@ class SqsApiListSqsCredentialsRequest: class SqsApiUpdateSqsCredentialsRequest: sqs_credentials_id: str """ - ID of the SQS credentials to update. + ID of the Queues credentials to update. """ region: Optional[Region] @@ -856,20 +856,20 @@ class SqsInfo: status: SqsInfoStatus """ - SQS activation status. + Queues activation status. """ sqs_endpoint_url: str """ - Endpoint of the SQS service for this region and project. + Endpoint of the Queues service for this region and project. """ created_at: Optional[datetime] """ - SQS creation date. + Queues creation date. """ updated_at: Optional[datetime] """ - SQS last modification date. + Queues last modification date. """ diff --git a/scaleway/scaleway/mnq/v1beta1/api.py b/scaleway/scaleway/mnq/v1beta1/api.py index 390189f88..515b7b7af 100644 --- a/scaleway/scaleway/mnq/v1beta1/api.py +++ b/scaleway/scaleway/mnq/v1beta1/api.py @@ -68,7 +68,7 @@ class MnqV1Beta1NatsAPI(API): """ - This API allows you to manage Scaleway Messaging and Queuing NATS accounts. + This API allows you to manage Scaleway NATS accounts. """ def create_nats_account( @@ -506,7 +506,7 @@ def list_nats_credentials_all( class MnqV1Beta1SnsAPI(API): """ - This API allows you to manage your Scaleway Messaging and Queuing SNS brokers. + This API allows you to manage your Scaleway Topics and Events. """ def activate_sns( @@ -516,10 +516,10 @@ def activate_sns( project_id: Optional[str] = None, ) -> SnsInfo: """ - Activate SNS. - Activate SNS for the specified Project ID. SNS must be activated before any usage. Activating SNS does not trigger any billing, and you can deactivate at any time. + Activate Topics and Events. + Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to activate the SNS service. + :param project_id: Project on which to activate the Topics and Events service. :return: :class:`SnsInfo ` Usage: @@ -554,10 +554,10 @@ def get_sns_info( project_id: Optional[str] = None, ) -> SnsInfo: """ - Get SNS info. - Retrieve the SNS information of the specified Project ID. Informations include the activation status and the SNS API endpoint URL. + Get Topics and Events info. + Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project to retrieve SNS info from. + :param project_id: Project to retrieve Topics and Events info from. :return: :class:`SnsInfo ` Usage: @@ -588,10 +588,10 @@ def deactivate_sns( project_id: Optional[str] = None, ) -> SnsInfo: """ - Deactivate SNS. - Deactivate SNS for the specified Project ID.You must delete all topics and credentials before this call or you need to set the force_delete parameter. + Deactivate Topics and Events. + Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to deactivate the SNS service. + :param project_id: Project on which to deactivate the Topics and Events service. :return: :class:`SnsInfo ` Usage: @@ -628,10 +628,10 @@ def create_sns_credentials( permissions: Optional[SnsPermissions] = None, ) -> SnsCredentials: """ - Create SNS credentials. - Create a set of credentials for SNS, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. + Create Topics and Events credentials. + Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project containing the SNS credentials. + :param project_id: Project containing the Topics and Events credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: :class:`SnsCredentials ` @@ -670,8 +670,8 @@ def delete_sns_credentials( region: Optional[Region] = None, ) -> None: """ - Delete SNS credentials. - Delete a set of SNS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SNS. + Delete Topics and Events credentials. + Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events. :param sns_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config. @@ -706,9 +706,9 @@ def update_sns_credentials( permissions: Optional[SnsPermissions] = None, ) -> SnsCredentials: """ - Update SNS credentials. - Update a set of SNS credentials. You can update the credentials' name, or their permissions. - :param sns_credentials_id: ID of the SNS credentials to update. + Update Topics and Events credentials. + Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions. + :param sns_credentials_id: ID of the Topics and Events credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. @@ -753,9 +753,9 @@ def get_sns_credentials( region: Optional[Region] = None, ) -> SnsCredentials: """ - Get SNS credentials. + Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. - :param sns_credentials_id: ID of the SNS credentials to get. + :param sns_credentials_id: ID of the Topics and Events credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`SnsCredentials ` @@ -792,10 +792,10 @@ def list_sns_credentials( order_by: Optional[ListSnsCredentialsRequestOrderBy] = None, ) -> ListSnsCredentialsResponse: """ - List SNS credentials. - List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Topics and Events credentials. + List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SNS credentials in this Project. + :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. @@ -835,10 +835,10 @@ def list_sns_credentials_all( order_by: Optional[ListSnsCredentialsRequestOrderBy] = None, ) -> List[SnsCredentials]: """ - List SNS credentials. - List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Topics and Events credentials. + List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SNS credentials in this Project. + :param project_id: Include only Topics and Events credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. @@ -866,7 +866,7 @@ def list_sns_credentials_all( class MnqV1Beta1SqsAPI(API): """ - This API allows you to manage your Scaleway Messaging and Queuing SQS brokers. + This API allows you to manage your Scaleway Queues. """ def activate_sqs( @@ -876,10 +876,10 @@ def activate_sqs( project_id: Optional[str] = None, ) -> SqsInfo: """ - Activate SQS. - Activate SQS for the specified Project ID. SQS must be activated before any usage such as creating credentials and queues. Activating SQS does not trigger any billing, and you can deactivate at any time. + Activate Queues. + Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to activate the SQS service. + :param project_id: Project on which to activate the Queues service. :return: :class:`SqsInfo ` Usage: @@ -914,10 +914,10 @@ def get_sqs_info( project_id: Optional[str] = None, ) -> SqsInfo: """ - Get SQS info. - Retrieve the SQS information of the specified Project ID. Informations include the activation status and the SQS API endpoint URL. + Get Queues info. + Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project to retrieve SQS info from. + :param project_id: Project to retrieve Queues info from. :return: :class:`SqsInfo ` Usage: @@ -948,10 +948,10 @@ def deactivate_sqs( project_id: Optional[str] = None, ) -> SqsInfo: """ - Deactivate SQS. - Deactivate SQS for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. + Deactivate Queues. + Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project on which to deactivate the SQS service. + :param project_id: Project on which to deactivate the Queues service. :return: :class:`SqsInfo ` Usage: @@ -988,10 +988,10 @@ def create_sqs_credentials( permissions: Optional[SqsPermissions] = None, ) -> SqsCredentials: """ - Create SQS credentials. - Create a set of credentials for SQS, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. + Create Queues credentials. + Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Project containing the SQS credentials. + :param project_id: Project containing the Queues credentials. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. :return: :class:`SqsCredentials ` @@ -1030,8 +1030,8 @@ def delete_sqs_credentials( region: Optional[Region] = None, ) -> None: """ - Delete SQS credentials. - Delete a set of SQS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SQS. + Delete Queues credentials. + Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues. :param sqs_credentials_id: ID of the credentials to delete. :param region: Region to target. If none is passed will use default region from the config. @@ -1066,9 +1066,9 @@ def update_sqs_credentials( permissions: Optional[SqsPermissions] = None, ) -> SqsCredentials: """ - Update SQS credentials. - Update a set of SQS credentials. You can update the credentials' name, or their permissions. - :param sqs_credentials_id: ID of the SQS credentials to update. + Update Queues credentials. + Update a set of Queues credentials. You can update the credentials' name, or their permissions. + :param sqs_credentials_id: ID of the Queues credentials to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the credentials. :param permissions: Permissions associated with these credentials. @@ -1113,9 +1113,9 @@ def get_sqs_credentials( region: Optional[Region] = None, ) -> SqsCredentials: """ - Get SQS credentials. + Get Queues credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. - :param sqs_credentials_id: ID of the SQS credentials to get. + :param sqs_credentials_id: ID of the Queues credentials to get. :param region: Region to target. If none is passed will use default region from the config. :return: :class:`SqsCredentials ` @@ -1152,10 +1152,10 @@ def list_sqs_credentials( order_by: Optional[ListSqsCredentialsRequestOrderBy] = None, ) -> ListSqsCredentialsResponse: """ - List SQS credentials. - List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Queues credentials. + List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SQS credentials in this Project. + :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. @@ -1195,10 +1195,10 @@ def list_sqs_credentials_all( order_by: Optional[ListSqsCredentialsRequestOrderBy] = None, ) -> List[SqsCredentials]: """ - List SQS credentials. - List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. + List Queues credentials. + List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. :param region: Region to target. If none is passed will use default region from the config. - :param project_id: Include only SQS credentials in this Project. + :param project_id: Include only Queues credentials in this Project. :param page: Page number to return. :param page_size: Maximum number of credentials to return per page. :param order_by: Order in which to return results. diff --git a/scaleway/scaleway/mnq/v1beta1/types.py b/scaleway/scaleway/mnq/v1beta1/types.py index e8f0a0d9f..0ef51e472 100644 --- a/scaleway/scaleway/mnq/v1beta1/types.py +++ b/scaleway/scaleway/mnq/v1beta1/types.py @@ -98,7 +98,7 @@ class File: class SnsPermissions: can_publish: Optional[bool] """ - Defines whether the credentials bearer can publish messages to the service (publish to SNS topics). + Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics). """ can_receive: Optional[bool] @@ -108,7 +108,7 @@ class SnsPermissions: can_manage: Optional[bool] """ - Defines whether the credentials bearer can manage the associated SNS topics or subscriptions. + Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions. """ @@ -116,17 +116,17 @@ class SnsPermissions: class SqsPermissions: can_publish: Optional[bool] """ - Defines whether the credentials bearer can publish messages to the service (send messages to SQS queues). + Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues). """ can_receive: Optional[bool] """ - Defines whether the credentials bearer can receive messages from SQS queues. + Defines whether the credentials bearer can receive messages from Queues queues. """ can_manage: Optional[bool] """ - Defines whether the credentials bearer can manage the associated SQS queues. + Defines whether the credentials bearer can manage the associated Queues queues. """ @@ -235,7 +235,7 @@ class SnsCredentials: secret_key: str """ - Secret key ID (Only returned by **Create SNS Credentials** call). + Secret key ID (Only returned by **Create Topics and Events Credentials** call). """ secret_checksum: str @@ -288,7 +288,7 @@ class SqsCredentials: secret_key: str """ - Secret key ID (Only returned by **Create SQS Credentials** call). + Secret key ID (Only returned by **Create Queues Credentials** call). """ secret_checksum: str @@ -347,7 +347,7 @@ class ListSnsCredentialsResponse: sns_credentials: List[SnsCredentials] """ - SNS credentials on this page. + Topics and Events credentials on this page. """ @@ -360,7 +360,7 @@ class ListSqsCredentialsResponse: sqs_credentials: List[SqsCredentials] """ - SQS credentials on this page. + Queues credentials on this page. """ @@ -540,7 +540,7 @@ class SnsApiActivateSnsRequest: project_id: Optional[str] """ - Project on which to activate the SNS service. + Project on which to activate the Topics and Events service. """ @@ -553,7 +553,7 @@ class SnsApiCreateSnsCredentialsRequest: project_id: Optional[str] """ - Project containing the SNS credentials. + Project containing the Topics and Events credentials. """ name: Optional[str] @@ -576,7 +576,7 @@ class SnsApiDeactivateSnsRequest: project_id: Optional[str] """ - Project on which to deactivate the SNS service. + Project on which to deactivate the Topics and Events service. """ @@ -597,7 +597,7 @@ class SnsApiDeleteSnsCredentialsRequest: class SnsApiGetSnsCredentialsRequest: sns_credentials_id: str """ - ID of the SNS credentials to get. + ID of the Topics and Events credentials to get. """ region: Optional[Region] @@ -615,7 +615,7 @@ class SnsApiGetSnsInfoRequest: project_id: Optional[str] """ - Project to retrieve SNS info from. + Project to retrieve Topics and Events info from. """ @@ -628,7 +628,7 @@ class SnsApiListSnsCredentialsRequest: project_id: Optional[str] """ - Include only SNS credentials in this Project. + Include only Topics and Events credentials in this Project. """ page: Optional[int] @@ -651,7 +651,7 @@ class SnsApiListSnsCredentialsRequest: class SnsApiUpdateSnsCredentialsRequest: sns_credentials_id: str """ - ID of the SNS credentials to update. + ID of the Topics and Events credentials to update. """ region: Optional[Region] @@ -684,22 +684,22 @@ class SnsInfo: status: SnsInfoStatus """ - SNS activation status. + Topics and Events activation status. """ sns_endpoint_url: str """ - Endpoint of the SNS service for this region and project. + Endpoint of the Topics and Events service for this region and project. """ created_at: Optional[datetime] """ - SNS creation date. + Topics and Events creation date. """ updated_at: Optional[datetime] """ - SNS last modification date. + Topics and Events last modification date. """ @@ -712,7 +712,7 @@ class SqsApiActivateSqsRequest: project_id: Optional[str] """ - Project on which to activate the SQS service. + Project on which to activate the Queues service. """ @@ -725,7 +725,7 @@ class SqsApiCreateSqsCredentialsRequest: project_id: Optional[str] """ - Project containing the SQS credentials. + Project containing the Queues credentials. """ name: Optional[str] @@ -748,7 +748,7 @@ class SqsApiDeactivateSqsRequest: project_id: Optional[str] """ - Project on which to deactivate the SQS service. + Project on which to deactivate the Queues service. """ @@ -769,7 +769,7 @@ class SqsApiDeleteSqsCredentialsRequest: class SqsApiGetSqsCredentialsRequest: sqs_credentials_id: str """ - ID of the SQS credentials to get. + ID of the Queues credentials to get. """ region: Optional[Region] @@ -787,7 +787,7 @@ class SqsApiGetSqsInfoRequest: project_id: Optional[str] """ - Project to retrieve SQS info from. + Project to retrieve Queues info from. """ @@ -800,7 +800,7 @@ class SqsApiListSqsCredentialsRequest: project_id: Optional[str] """ - Include only SQS credentials in this Project. + Include only Queues credentials in this Project. """ page: Optional[int] @@ -823,7 +823,7 @@ class SqsApiListSqsCredentialsRequest: class SqsApiUpdateSqsCredentialsRequest: sqs_credentials_id: str """ - ID of the SQS credentials to update. + ID of the Queues credentials to update. """ region: Optional[Region] @@ -856,20 +856,20 @@ class SqsInfo: status: SqsInfoStatus """ - SQS activation status. + Queues activation status. """ sqs_endpoint_url: str """ - Endpoint of the SQS service for this region and project. + Endpoint of the Queues service for this region and project. """ created_at: Optional[datetime] """ - SQS creation date. + Queues creation date. """ updated_at: Optional[datetime] """ - SQS last modification date. + Queues last modification date. """