Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
Parameters:
-
registration_status
(Optional[RegistrationStatus], default:
None
)
–
The registration status of the on-premises instances:
-
tag_filters
(Optional[TagFilterList], default:
None
)
–
The on-premises instance tags that are used to restrict the on-premises instance names returned.
-
next_token
(Optional[NextToken], default:
None
)
–
An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
Raises:
Source code in docs_src/capo_codedeploy/_services/code_deploy.py
| def list_on_premises_instances(
self,
*,
config_overrides: Optional[CodeDeployClientConfig] = None,
registration_status: Optional[
"capo_codedeploy.types.registration_status.RegistrationStatus"
] = None,
tag_filters: Optional[
"capo_codedeploy.types.tag_filter_list.TagFilterList"
] = None,
next_token: Optional["capo_codedeploy.types.next_token.NextToken"] = None,
) -> "capo_codedeploy.types.list_on_premises_instances_output.ListOnPremisesInstancesOutput":
"""<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.</p>
Args:
registration_status: <p>The registration status of the on-premises instances:</p> <ul> <li> <p> <code>Deregistered</code>: Include deregistered on-premises instances in the resulting list.</p> </li> <li> <p> <code>Registered</code>: Include registered on-premises instances in the resulting list.</p> </li> </ul>
tag_filters: <p>The on-premises instance tags that are used to restrict the on-premises instance names returned.</p>
next_token: <p>An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.</p>
Raises:
capo_codedeploy.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The next token was specified in an invalid format.</p>
capo_codedeploy.errors.invalid_registration_status_exception.InvalidRegistrationStatusException: <p>The registration status was specified in an invalid format.</p>
capo_codedeploy.errors.invalid_tag_filter_exception.InvalidTagFilterException: <p>The tag filter was specified in an invalid format.</p>
capo_codedeploy.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_codedeploy.types.list_on_premises_instances_input.ListOnPremisesInstancesInput]",
) -> OperationResponse[
"capo_codedeploy.types.list_on_premises_instances_output.ListOnPremisesInstancesOutput"
]:
import capo_codedeploy._operations.code_deploy_20141006.list_on_premises_instances
output, http_response = (
capo_codedeploy._operations.code_deploy_20141006.list_on_premises_instances.list_on_premises_instances(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListOnPremisesInstances")
)
input_: capo_codedeploy.types.list_on_premises_instances_input.ListOnPremisesInstancesInput = {}
if registration_status is not None:
input_["registration_status"] = registration_status
if tag_filters is not None:
input_["tag_filters"] = tag_filters
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
|