describe_applications `async` ¶

describe_applications(
    *,
    config_overrides: Optional[AsyncElasticBeanstalkClientConfig] = None,
    application_names: Optional[ApplicationNamesList] = None,
) -> ApplicationDescriptionsMessage

Returns the descriptions of existing applications.

This action only returns information about applications that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access two of three applications. When the user calls the DescribeApplications action, the response will only include the two applications that the user has permission to access instead of all three applications. If the user doesn’t have access to any of the applications an empty result is returned.

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see Managing Elastic Beanstalk user policies in the Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

Parameters:

application_names (Optional[ApplicationNamesList], default: None ) –

If specified, Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To view a list of applications The following operation retrieves information about applications in the current region:

>>> await client.describe_applications()

Source code in docs_src/capo_elastic_beanstalk/_services/async_elastic_beanstalk.py

async def describe_applications(
    self,
    *,
    config_overrides: Optional[AsyncElasticBeanstalkClientConfig] = None,
    application_names: Optional[
        "capo_elastic_beanstalk.types.application_names_list.ApplicationNamesList"
    ] = None,
) -> "capo_elastic_beanstalk.types.application_descriptions_message.ApplicationDescriptionsMessage":
    """<p>Returns the descriptions of existing applications.</p> <p>This action only returns information about applications that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access two of three applications. When the user calls the <i>DescribeApplications</i> action, the response will only include the two applications that the user has permission to access instead of all three applications. If the user doesn’t have access to any of the applications an empty result is returned.</p> <note> <p>The <i>AWSElasticBeanstalkReadOnly</i> managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html"> Managing Elastic Beanstalk user policies</a> in the <i>Elastic Beanstalk Developer Guide</i>. For detailed instructions to attach a policy to a user or group, see the section <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#iam-userpolicies-managed"> Controlling access with managed policies</a> in the same topic.</p> </note>

    Args:
        application_names: <p>If specified, Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.</p>

    Raises:
        capo_elastic_beanstalk.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To view a list of applications
        The following operation retrieves information about applications in the current region:

        >>> await client.describe_applications()
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elastic_beanstalk.types.describe_applications_message.DescribeApplicationsMessage]",
    ) -> AsyncOperationResponse[
        "capo_elastic_beanstalk.types.application_descriptions_message.ApplicationDescriptionsMessage"
    ]:
        import capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_applications

        (
            output,
            http_response,
        ) = await capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_applications.async_describe_applications(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApplications")
    )
    input_: capo_elastic_beanstalk.types.describe_applications_message.DescribeApplicationsMessage = {}
    if application_names is not None:
        input_["application_names"] = application_names

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_applications async ¶

describe_applications `async` ¶