put_application_assignment_configuration ¶

put_application_assignment_configuration(
    application_arn: ApplicationArn,
    assignment_required: AssignmentRequired,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> PutApplicationAssignmentConfigurationResponse

Configure how users gain access to an application. If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.

Parameters:

application_arn (ApplicationArn) –

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
assignment_required (AssignmentRequired) –

If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
InternalServerException –

The request processing has failed because of an unknown error, exception, or failure with an internal server.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

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

Source code in docs_src/capo_sso_admin/_services/sso_admin.py

def put_application_assignment_configuration(
    self,
    application_arn: "capo_sso_admin.types.application_arn.ApplicationArn",
    assignment_required: "capo_sso_admin.types.assignment_required.AssignmentRequired",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.put_application_assignment_configuration_response.PutApplicationAssignmentConfigurationResponse":
    """<p>Configure how users gain access to an application. If <code>AssignmentsRequired</code> is <code>true</code> (default value), users don’t have access to the application unless an assignment is created using the <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html">CreateApplicationAssignment API</a>. If <code>false</code>, all users have access to the application. If an assignment is created using <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html">CreateApplicationAssignment</a>., the user retains access if <code>AssignmentsRequired</code> is set to <code>true</code>. </p>

    Args:
        application_arn: <p>Specifies the ARN of the application. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
        assignment_required: <p>If <code>AssignmentsRequired</code> is <code>true</code> (default value), users don’t have access to the application unless an assignment is created using the <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html">CreateApplicationAssignment API</a>. If <code>false</code>, all users have access to the application. </p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.put_application_assignment_configuration_request.PutApplicationAssignmentConfigurationRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.put_application_assignment_configuration_response.PutApplicationAssignmentConfigurationResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.put_application_assignment_configuration

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.put_application_assignment_configuration.put_application_assignment_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutApplicationAssignmentConfiguration")
    )
    input_: capo_sso_admin.types.put_application_assignment_configuration_request.PutApplicationAssignmentConfigurationRequest = {
        "application_arn": application_arn,
        "assignment_required": assignment_required,
    }

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