Returns the description of the specified StackSet.
This API provides strongly consistent reads meaning it will always return the most up-to-date data.
Parameters:
-
stack_set_name
(Optional[StackSetName], default:
None
)
–
The name or unique ID of the StackSet whose description you want.
-
call_as
(Optional[CallAs], default:
None
)
–
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for StackSets with self-managed permissions.
-
If you are signed in to the management account, specify SELF.
-
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Raises:
Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
| def describe_stack_set(
self,
*,
config_overrides: Optional[CloudFormationClientConfig] = None,
stack_set_name: Optional[
"capo_cloudformation.types.stack_set_name.StackSetName"
] = None,
call_as: Optional["capo_cloudformation.types.call_as.CallAs"] = None,
) -> "capo_cloudformation.types.describe_stack_set_output.DescribeStackSetOutput":
"""<p>Returns the description of the specified StackSet.</p> <note> <p>This API provides <i>strongly consistent</i> reads meaning it will always return the most up-to-date data.</p> </note>
Args:
stack_set_name: <p>The name or unique ID of the StackSet whose description you want.</p>
call_as: <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>
Raises:
capo_cloudformation.errors.stack_set_not_found_exception.StackSetNotFoundException: <p>The specified StackSet doesn't exist.</p>
capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cloudformation.types.describe_stack_set_input.DescribeStackSetInput]",
) -> OperationResponse[
"capo_cloudformation.types.describe_stack_set_output.DescribeStackSetOutput"
]:
import capo_cloudformation._operations.cloud_formation.describe_stack_set
output, http_response = (
capo_cloudformation._operations.cloud_formation.describe_stack_set.describe_stack_set(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeStackSet")
)
input_: capo_cloudformation.types.describe_stack_set_input.DescribeStackSetInput = {}
if stack_set_name is not None:
input_["stack_set_name"] = stack_set_name
if call_as is not None:
input_["call_as"] = call_as
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|