Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
Parameters:
-
bundle_ids
(Optional[BundleIdList], default:
None
)
–
The identifiers of the bundles. You cannot combine this parameter with any other filter.
-
owner
(Optional[BundleOwner], default:
None
)
–
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.
-
next_token
(Optional[PaginationToken], default:
None
)
–
The token for the next set of results. (You received this token from a previous call.)
Raises:
Source code in docs_src/capo_workspaces/_services/work_spaces.py
| def describe_workspace_bundles(
self,
*,
config_overrides: Optional[WorkSpacesClientConfig] = None,
bundle_ids: Optional[
"capo_workspaces.types.bundle_id_list.BundleIdList"
] = None,
owner: Optional["capo_workspaces.types.bundle_owner.BundleOwner"] = None,
next_token: Optional[
"capo_workspaces.types.pagination_token.PaginationToken"
] = None,
) -> "capo_workspaces.types.describe_workspace_bundles_result.DescribeWorkspaceBundlesResult":
"""<p>Retrieves a list that describes the available WorkSpace bundles.</p> <p>You can filter the results using either bundle ID or owner, but not both.</p>
Args:
bundle_ids: <p>The identifiers of the bundles. You cannot combine this parameter with any other filter.</p>
owner: <p>The owner of the bundles. You cannot combine this parameter with any other filter.</p> <p>To describe the bundles provided by Amazon Web Services, specify <code>AMAZON</code>. To describe the bundles that belong to your account, don't specify a value.</p>
next_token: <p>The token for the next set of results. (You received this token from a previous call.)</p>
Raises:
capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_workspaces.types.describe_workspace_bundles_request.DescribeWorkspaceBundlesRequest]",
) -> OperationResponse[
"capo_workspaces.types.describe_workspace_bundles_result.DescribeWorkspaceBundlesResult"
]:
import capo_workspaces._operations.workspaces_service.describe_workspace_bundles
output, http_response = (
capo_workspaces._operations.workspaces_service.describe_workspace_bundles.describe_workspace_bundles(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeWorkspaceBundles")
)
input_: capo_workspaces.types.describe_workspace_bundles_request.DescribeWorkspaceBundlesRequest = {}
if bundle_ids is not None:
input_["bundle_ids"] = bundle_ids
if owner is not None:
input_["owner"] = owner
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|