Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
This action only returns information about resources 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 resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.
The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk. 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_name
(Optional[ApplicationName], default:
None
)
–
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
-
template_name
(Optional[ConfigurationTemplateName], default:
None
)
–
The name of the configuration template whose configuration options you want to describe.
-
environment_name
(Optional[EnvironmentName], default:
None
)
–
The name of the environment whose configuration options you want to describe.
-
solution_stack_name
(Optional[SolutionStackName], default:
None
)
–
The name of the solution stack whose configuration options you want to describe.
-
platform_arn
(Optional[PlatformArn], default:
None
)
–
The ARN of the custom platform.
-
options
(Optional[OptionsSpecifierList], default:
None
)
–
If specified, restricts the descriptions to only the specified options.
Raises:
Examples:
To view configuration options for an environment
The following operation retrieves descriptions of all available configuration options for an environment named my-env:
>>> client.describe_configuration_options(application_name='my-app', environment_name='my-env')
Source code in docs_src/capo_elastic_beanstalk/_services/elastic_beanstalk.py
| def describe_configuration_options(
self,
*,
config_overrides: Optional[ElasticBeanstalkClientConfig] = None,
application_name: Optional[
"capo_elastic_beanstalk.types.application_name.ApplicationName"
] = None,
template_name: Optional[
"capo_elastic_beanstalk.types.configuration_template_name.ConfigurationTemplateName"
] = None,
environment_name: Optional[
"capo_elastic_beanstalk.types.environment_name.EnvironmentName"
] = None,
solution_stack_name: Optional[
"capo_elastic_beanstalk.types.solution_stack_name.SolutionStackName"
] = None,
platform_arn: Optional[
"capo_elastic_beanstalk.types.platform_arn.PlatformArn"
] = None,
options: Optional[
"capo_elastic_beanstalk.types.options_specifier_list.OptionsSpecifierList"
] = None,
) -> "capo_elastic_beanstalk.types.configuration_options_description.ConfigurationOptionsDescription":
"""<p>Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.</p> <p>This action only returns information about resources 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 resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources 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. 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_name: <p>The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.</p>
template_name: <p>The name of the configuration template whose configuration options you want to describe.</p>
environment_name: <p>The name of the environment whose configuration options you want to describe.</p>
solution_stack_name: <p>The name of the solution stack whose configuration options you want to describe.</p>
platform_arn: <p>The ARN of the custom platform.</p>
options: <p>If specified, restricts the descriptions to only the specified options.</p>
Raises:
capo_elastic_beanstalk.errors.too_many_buckets_exception.TooManyBucketsException: <p>The specified account has reached its limit of Amazon S3 buckets.</p>
capo_elastic_beanstalk.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To view configuration options for an environment
The following operation retrieves descriptions of all available configuration options for an environment named my-env:
>>> client.describe_configuration_options(application_name='my-app', environment_name='my-env')
"""
def _handler(
req: "OperationRequest[capo_elastic_beanstalk.types.describe_configuration_options_message.DescribeConfigurationOptionsMessage]",
) -> OperationResponse[
"capo_elastic_beanstalk.types.configuration_options_description.ConfigurationOptionsDescription"
]:
import capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_configuration_options
output, http_response = (
capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.describe_configuration_options.describe_configuration_options(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeConfigurationOptions")
)
input_: capo_elastic_beanstalk.types.describe_configuration_options_message.DescribeConfigurationOptionsMessage = {}
if application_name is not None:
input_["application_name"] = application_name
if template_name is not None:
input_["template_name"] = template_name
if environment_name is not None:
input_["environment_name"] = environment_name
if solution_stack_name is not None:
input_["solution_stack_name"] = solution_stack_name
if platform_arn is not None:
input_["platform_arn"] = platform_arn
if options is not None:
input_["options"] = options
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|