Lists an environment's upcoming and in-progress managed actions.
This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three environments. When the user calls this action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments 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:
-
environment_name
(Optional[String], default:
None
)
–
The name of the target environment.
-
environment_id
(Optional[String], default:
None
)
–
The environment ID of the target environment.
-
status
(Optional[ActionStatus], default:
None
)
–
To show only actions with a particular status, specify a status.
Raises:
Source code in docs_src/capo_elastic_beanstalk/_services/elastic_beanstalk.py
| def describe_environment_managed_actions(
self,
*,
config_overrides: Optional[ElasticBeanstalkClientConfig] = None,
environment_name: Optional["capo_elastic_beanstalk.types.string.String"] = None,
environment_id: Optional["capo_elastic_beanstalk.types.string.String"] = None,
status: Optional[
"capo_elastic_beanstalk.types.action_status.ActionStatus"
] = None,
) -> "capo_elastic_beanstalk.types.describe_environment_managed_actions_result.DescribeEnvironmentManagedActionsResult":
"""<p>Lists an environment's upcoming and in-progress managed actions.</p> <p>This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three environments. When the user calls this action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned.</p> <note> <p>The <a href="https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSElasticBeanstalkReadOnly.html">AWSElasticBeanstalkReadOnly</a> 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:
environment_name: <p>The name of the target environment.</p>
environment_id: <p>The environment ID of the target environment.</p>
status: <p>To show only actions with a particular status, specify a status.</p>
Raises:
capo_elastic_beanstalk.errors.elastic_beanstalk_service_exception.ElasticBeanstalkServiceException: <p>A generic service exception has occurred.</p>
capo_elastic_beanstalk.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_elastic_beanstalk.types.describe_environment_managed_actions_request.DescribeEnvironmentManagedActionsRequest]",
) -> OperationResponse[
"capo_elastic_beanstalk.types.describe_environment_managed_actions_result.DescribeEnvironmentManagedActionsResult"
]:
import capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_environment_managed_actions
output, http_response = (
capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_environment_managed_actions.describe_environment_managed_actions(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeEnvironmentManagedActions")
)
input_: capo_elastic_beanstalk.types.describe_environment_managed_actions_request.DescribeEnvironmentManagedActionsRequest = {}
if environment_name is not None:
input_["environment_name"] = environment_name
if environment_id is not None:
input_["environment_id"] = environment_id
if status is not None:
input_["status"] = status
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|