Skip to content

list_components 

list_components(
    *,
    config_overrides: Optional[SsmSapClientConfig] = None,
    application_id: Optional[ApplicationId] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListComponentsOutput

Lists all the components registered with AWS Systems Manager for SAP.

Parameters:

  • application_id (Optional[ApplicationId], default: None ) –

    The ID of the application.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Raises:

Source code in docs_src/capo_ssm_sap/_services/ssm_sap.py 
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
def list_components(
    self,
    *,
    config_overrides: Optional[SsmSapClientConfig] = None,
    application_id: Optional[
        "capo_ssm_sap.types.application_id.ApplicationId"
    ] = None,
    next_token: Optional["capo_ssm_sap.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ssm_sap.types.max_results.MaxResults"] = None,
) -> "capo_ssm_sap.types.list_components_output.ListComponentsOutput":
    """<p>Lists all the components registered with AWS Systems Manager for SAP.</p>

    Args:
        application_id: <p>The ID of the application.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.</p> <p>If you do not specify a value for MaxResults, the request returns 50 items per page by default.</p>

    Raises:
        capo_ssm_sap.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_ssm_sap.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource is not available.</p>
        capo_ssm_sap.errors.unauthorized_exception.UnauthorizedException: <p>The request is not authorized.</p>
        capo_ssm_sap.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service. </p>
        capo_ssm_sap.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm_sap.types.list_components_input.ListComponentsInput]",
    ) -> OperationResponse[
        "capo_ssm_sap.types.list_components_output.ListComponentsOutput"
    ]:
        import capo_ssm_sap._operations.ssm_sap.list_components

        output, http_response = (
            capo_ssm_sap._operations.ssm_sap.list_components.list_components(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListComponents")
    )
    input_: capo_ssm_sap.types.list_components_input.ListComponentsInput = {}
    if application_id is not None:
        input_["application_id"] = application_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output