Skip to content

get_apps 

get_apps(
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    page_size: Optional[__string] = None,
    token: Optional[__string] = None,
) -> GetAppsResponse

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

Parameters:

  • page_size (Optional[__string], default: None ) –

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

  • token (Optional[__string], default: None ) –

    The NextToken string that specifies which page of results to return in a paginated response.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
def get_apps(
    self,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    page_size: Optional["capo_pinpoint.types.__string.__string"] = None,
    token: Optional["capo_pinpoint.types.__string.__string"] = None,
) -> "capo_pinpoint.types.get_apps_response.GetAppsResponse":
    """<p>Retrieves information about all the applications that are associated with your Amazon Pinpoint account.</p>

    Args:
        page_size: <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
        token: <p>The NextToken string that specifies which page of results to return in a paginated response.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.get_apps_request.GetAppsRequest]",
    ) -> OperationResponse["capo_pinpoint.types.get_apps_response.GetAppsResponse"]:
        import capo_pinpoint._operations.pinpoint.get_apps

        output, http_response = (
            capo_pinpoint._operations.pinpoint.get_apps.get_apps(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetApps")
    )
    input_: capo_pinpoint.types.get_apps_request.GetAppsRequest = {}
    if page_size is not None:
        input_["page_size"] = page_size
    if token is not None:
        input_["token"] = token

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